Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Miscellaneous docs clean up #4012

Merged
merged 6 commits into from
Mar 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,16 @@ you can configure it using one of the methods below, listed in descending order
[horizontal]
1) {apm-app-ref}/agent-configuration.html[Central configuration]::
Configure the Agent in the Kibana APM app.
<<configuration-dynamic, image:./images/dynamic-config.svg[] >>
<<configuration-dynamic, image:/reference/images/dynamic-config.svg[] >>

2) Properties file::
The `elasticapm.properties` file is located in the same folder as the agent jar,
or provided through the <<config-config-file,`config_file`>> option.
image:./images/dynamic-config.svg[link=configuration.html#configuration-dynamic]
image:/reference/images/dynamic-config.svg[link=configuration.html#configuration-dynamic]

3) Java system properties::
All configuration keys are prefixed with `elastic.apm.` +
image:./images/dynamic-config.svg[link=configuration.html#configuration-dynamic]
image:/reference/images/dynamic-config.svg[link=configuration.html#configuration-dynamic]

4) Environment variables::
All configuration keys are in uppercase and prefixed with `ELASTIC_APM_`.
Expand All @@ -36,7 +36,7 @@ Defined for each configuration.

[float]
[[configuration-dynamic]]
=== Dynamic configuration image:./images/dynamic-config.svg[]
=== Dynamic configuration image:/reference/images/dynamic-config.svg[]

Configuration options marked with Dynamic true can be changed at runtime when set from supported sources:

Expand Down Expand Up @@ -119,7 +119,7 @@ NOTE: This feature is currently experimental, which means it is disabled by defa
</#if>
${option.description}

<#if option.dynamic><<configuration-dynamic, image:./images/dynamic-config.svg[] >></#if>
<#if option.dynamic><<configuration-dynamic, image:/reference/images/dynamic-config.svg[] >></#if>

<#if option.valueType?matches("TimeDuration")>
<#if option.valueConverter.canUseMicros>
Expand Down
476 changes: 0 additions & 476 deletions docs/docset.yml

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/reference/aws-lambda.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Both the [{{apm-lambda-ext}}](apm-aws-lambda://reference/index.md) and the Java
To add the layers to your Lambda function through the AWS Management Console:

1. Navigate to your function in the AWS Management Console
2. Scroll to the Layers section and click the *Add a layer* button ![image of layer configuration section in AWS Console](../images/config-layer.png "")
2. Scroll to the Layers section and click the *Add a layer* button ![image of layer configuration section in AWS Console](images/config-layer.png "")
3. Choose the *Specify an ARN* radio button
4. Copy and paste the following ARNs of the {{apm-lambda-ext}} layer and the APM agent layer in the *Specify an ARN* text input:
* APM Extension layer:
Expand Down Expand Up @@ -169,7 +169,7 @@ ELASTIC_APM_SEND_STRATEGY = background <4>
3. This is your APM secret token.
4. The [ELASTIC_APM_SEND_STRATEGY](apm-aws-lambda://reference/aws-lambda-config-options.md#_elastic_apm_send_strategy) defines when APM data is sent to your Elastic APM backend. To reduce the execution time of your lambda functions, we recommend to use the background strategy in production environments with steady load scenarios.

![Java environment variables configuration section in AWS Console](../images/java-lambda-env-vars.png "")
![Java environment variables configuration section in AWS Console](images/java-lambda-env-vars.png "")
::::::

::::::{tab-item} AWS CLI
Expand Down
12 changes: 6 additions & 6 deletions docs/reference/config-circuit-breaker.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ mapped_pages:

A boolean specifying whether the circuit breaker should be enabled or not. When enabled, the agent periodically polls stress monitors to detect system/process/JVM stress state. If ANY of the monitors detects a stress indication, the agent will become inactive, as if the [`recording`](/reference/config-core.md#config-recording) configuration option has been set to `false`, thus reducing resource consumption to a minimum. When inactive, the agent continues polling the same monitors in order to detect whether the stress state has been relieved. If ALL monitors approve that the system/process/JVM is not under stress anymore, the agent will resume and become fully functional.

[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)
[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)

| Default | Type | Dynamic |
| --- | --- | --- |
Expand Down Expand Up @@ -42,7 +42,7 @@ Supports the duration suffixes `ms`, `s` and `m`. Example: `5s`.

The threshold used by the GC monitor to rely on for identifying heap stress. The same threshold will be used for all heap pools, so that if ANY has a usage percentage that crosses it, the agent will consider it as a heap stress. The GC monitor relies only on memory consumption measured after a recent GC.

[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)
[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)

| Default | Type | Dynamic |
| --- | --- | --- |
Expand All @@ -57,7 +57,7 @@ The threshold used by the GC monitor to rely on for identifying heap stress. The

The threshold used by the GC monitor to rely on for identifying when the heap is not under stress . If `stress_monitor_gc_stress_threshold` has been crossed, the agent will consider it a heap-stress state. In order to determine that the stress state is over, percentage of occupied memory in ALL heap pools should be lower than this threshold. The GC monitor relies only on memory consumption measured after a recent GC.

[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)
[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)

| Default | Type | Dynamic |
| --- | --- | --- |
Expand All @@ -72,7 +72,7 @@ The threshold used by the GC monitor to rely on for identifying when the heap is

The minimal time required in order to determine whether the system is either currently under stress, or that the stress detected previously has been relieved. All measurements during this time must be consistent in comparison to the relevant threshold in order to detect a change of stress state. Must be at least `1m`.

[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)
[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)

Supports the duration suffixes `ms`, `s` and `m`. Example: `1m`.

Expand All @@ -89,7 +89,7 @@ Supports the duration suffixes `ms`, `s` and `m`. Example: `1m`.

The threshold used by the system CPU monitor to detect system CPU stress. If the system CPU crosses this threshold for a duration of at least `stress_monitor_cpu_duration_threshold`, the monitor considers this as a stress state.

[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)
[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)

| Default | Type | Dynamic |
| --- | --- | --- |
Expand All @@ -104,7 +104,7 @@ The threshold used by the system CPU monitor to detect system CPU stress. If the

The threshold used by the system CPU monitor to determine that the system is not under CPU stress. If the monitor detected a CPU stress, the measured system CPU needs to be below this threshold for a duration of at least `stress_monitor_cpu_duration_threshold` in order for the monitor to decide that the CPU stress has been relieved.

[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)
[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)

| Default | Type | Dynamic |
| --- | --- | --- |
Expand Down
42 changes: 21 additions & 21 deletions docs/reference/config-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ A boolean specifying if the agent should be recording or not. When recording, th

You can use this setting to dynamically disable Elastic APM at runtime.

[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)
[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)

| Default | Type | Dynamic |
| --- | --- | --- |
Expand Down Expand Up @@ -57,7 +57,7 @@ Changing this value at runtime can slow down the application temporarily.
::::


[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)
[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)

| Default | Type | Dynamic |
| --- | --- | --- |
Expand Down Expand Up @@ -212,7 +212,7 @@ By default, the agent will sample every transaction (e.g. request to your servic

Value will be rounded with 4 significant digits, as an example, value *0.55555* will be rounded to `0.5556`

[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)
[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)

| Default | Type | Dynamic |
| --- | --- | --- |
Expand All @@ -233,7 +233,7 @@ Setting an upper limit will prevent overloading the agent and the APM server wit

A message will be logged when the max number of spans has been exceeded but only at a rate of once every 5 minutes to ensure performance is not impacted.

[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)
[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)

| Default | Type | Dynamic |
| --- | --- | --- |
Expand Down Expand Up @@ -281,7 +281,7 @@ Review the data captured by Elastic APM carefully to make sure it does not captu
::::


[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)
[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)

| Default | Type | Dynamic |
| --- | --- | --- |
Expand All @@ -301,7 +301,7 @@ Changing this value at runtime can slow down the application temporarily.
::::


[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)
[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)

| Default | Type | Dynamic |
| --- | --- | --- |
Expand All @@ -321,7 +321,7 @@ Changing this value at runtime can slow down the application temporarily.
::::


[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)
[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)

| Default | Type | Dynamic |
| --- | --- | --- |
Expand All @@ -341,7 +341,7 @@ Changing this value at runtime can slow down the application temporarily. Settin
::::


[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)
[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)

| Default | Type | Dynamic |
| --- | --- | --- |
Expand All @@ -358,7 +358,7 @@ When reporting exceptions, un-nests the exceptions matching the wildcard pattern

This option supports the wildcard `*`, which matches zero or more characters. Examples: `/foo/*/bar/*/baz*`, `*foo*`. Matching is case insensitive by default. Prepending an element with `(?-i)` makes the matching case sensitive.

[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)
[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)

| Default | Type | Dynamic |
| --- | --- | --- |
Expand Down Expand Up @@ -386,7 +386,7 @@ Exception inheritance is not supported, thus you have to explicitly list all the
::::


[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)
[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)

| Default | Type | Dynamic |
| --- | --- | --- |
Expand Down Expand Up @@ -420,7 +420,7 @@ Request bodies often contain sensitive values like passwords, credit card number
::::


[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)
[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)

Valid options: `off`, `errors`, `transactions`, `all`

Expand All @@ -442,7 +442,7 @@ Setting this to `false` reduces network bandwidth, disk space and object allocat
::::


[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)
[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)

| Default | Type | Dynamic |
| --- | --- | --- |
Expand Down Expand Up @@ -488,7 +488,7 @@ A boolean specifying if the agent should instrument pre-Java-1.4 bytecode.

When set to true, disables log sending, metrics and trace collection. Trace context propagation and log correlation will stay active. Note that in contrast to [`disable_send`](/reference/config-reporter.md#config-disable-send) the agent will still connect to the APM-server for fetching configuration updates and health checks.

[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)
[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)

| Default | Type | Dynamic |
| --- | --- | --- |
Expand Down Expand Up @@ -576,7 +576,7 @@ Changing this value at runtime can slow down the application temporarily.
::::


[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)
[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)

| Default | Type | Dynamic |
| --- | --- | --- |
Expand Down Expand Up @@ -623,7 +623,7 @@ Supports the duration suffixes `ms`, `s` and `m`. Example: `0ms`.

When enabled, the agent will make periodic requests to the APM Server to fetch updated configuration. The frequency of the periodic request is driven by the `Cache-Control` header returned from APM Server/Integration, falling back to 5 minutes if not defined.

[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)
[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)

| Default | Type | Dynamic |
| --- | --- | --- |
Expand Down Expand Up @@ -691,7 +691,7 @@ To enable [distributed tracing](docs-content://solutions/observability/apps/trac

When this setting is `true`, the agent will also add the header `elastic-apm-traceparent` for backwards compatibility with older versions of Elastic APM agents.

[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)
[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)

| Default | Type | Dynamic |
| --- | --- | --- |
Expand All @@ -711,7 +711,7 @@ Disabling `tracecontext` headers injection means that [distributed tracing](docs
::::


[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)
[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)

| Default | Type | Dynamic |
| --- | --- | --- |
Expand All @@ -730,7 +730,7 @@ The attempt fails if they lead up to a span that can’t be discarded. Spans tha

However, external calls that don’t propagate context, such as calls to a database, can be discarded using this threshold.

[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)
[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)

Supports the duration suffixes `ms`, `s` and `m`. Example: `0ms`.

Expand Down Expand Up @@ -777,7 +777,7 @@ With this option, you can group transaction names that contain dynamic parts wit

This option supports the wildcard `*`, which matches zero or more characters. Examples: `/foo/*/bar/*/baz*`, `*foo*`. Matching is case insensitive by default. Prepending an element with `(?-i)` makes the matching case sensitive.

[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)
[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)

| Default | Type | Dynamic |
| --- | --- | --- |
Expand Down Expand Up @@ -805,7 +805,7 @@ Starting with Elastic Observability 8.2, span links are visible in trace views.

This option is case-insensitive.

[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)
[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)

Valid options: `continue`, `restart`, `restart_external`

Expand All @@ -822,7 +822,7 @@ Valid options: `continue`, `restart`, `restart_external`

If any baggage key matches any of the patterns provided via this config option, the corresponding baggage key and value will be automatically stored on the corresponding transactions, spans and errors. The baggage keys will be prefixed with "baggage." on storage.

[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)
[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)

| Default | Type | Dynamic |
| --- | --- | --- |
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/config-datastore.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The URL path patterns for which the APM agent will capture the request body of o

The captured request body (if any) is stored on the `span.db.statement` field. Captured request bodies are truncated to a maximum length defined by [`long_field_max_length` (performance [1.37.0])](/reference/config-core.md#config-long-field-max-length). This option supports the wildcard `*`, which matches zero or more characters. Examples: `/foo/*/bar/*/baz*`, `*foo*`. Matching is case insensitive by default. Prepending an element with `(?-i)` makes the matching case sensitive.

[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)
[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)

| Default | Type | Dynamic |
| --- | --- | --- |
Expand All @@ -31,7 +31,7 @@ MongoDB command names for which the command document will be captured, limited t

This option supports the wildcard `*`, which matches zero or more characters. Examples: `/foo/*/bar/*/baz*`, `*foo*`. Matching is case insensitive by default. Prepending an element with `(?-i)` makes the matching case sensitive.

[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)
[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic)

| Default | Type | Dynamic |
| --- | --- | --- |
Expand Down
Loading
Loading