Skip to content

Commit 693318c

Browse files
fix image paths for docs-assembler (#2274)
1 parent ef9c62f commit 693318c

File tree

1 file changed

+29
-29
lines changed

1 file changed

+29
-29
lines changed

docs/reference/configuration.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ ELASTIC_APM = {
2929

3030
The precedence is as follows:
3131

32-
* [Central configuration](#config-central_config) (supported options are marked with [![dynamic config](/reference/images/dynamic-config.svg "") ](#dynamic-configuration))
32+
* [Central configuration](#config-central_config) (supported options are marked with [![dynamic config](images/dynamic-config.svg "") ](#dynamic-configuration))
3333
* Environment variables
3434
* Inline configuration
3535
* Framework-specific configuration
@@ -38,7 +38,7 @@ The precedence is as follows:
3838

3939
## Dynamic configuration [dynamic-configuration]
4040

41-
Configuration options marked with the ![dynamic config](/reference/images/dynamic-config.svg "") badge can be changed at runtime when set from a supported source.
41+
Configuration options marked with the ![dynamic config](images/dynamic-config.svg "") badge can be changed at runtime when set from a supported source.
4242

4343
The Python Agent supports [Central configuration](docs-content://solutions/observability/apm/apm-agent-central-configuration.md), which allows you to fine-tune certain configurations from in the APM app. This feature is enabled in the Agent by default with [`central_config`](#config-central_config).
4444

@@ -94,7 +94,7 @@ The service name must conform to this regular expression: `^[a-zA-Z0-9 _-]+$`. I
9494
| --- | --- | --- |
9595
| `ELASTIC_APM_SERVER_URL` | `SERVER_URL` | `'http://127.0.0.1:8200'` |
9696

97-
The URL for your APM Server. The URL must be fully qualified, including protocol (`http` or `https`) and port. Note: Do not set this if you are using APM in an AWS lambda function. APM Agents are designed to proxy their calls to the APM Server through the lambda extension. Instead, set `ELASTIC_APM_LAMBDA_APM_SERVER`. For more info, see [AWS Lambda](/reference/lambda-support.md).
97+
The URL for your APM Server. The URL must be fully qualified, including protocol (`http` or `https`) and port. Note: Do not set this if you are using APM in an AWS lambda function. APM Agents are designed to proxy their calls to the APM Server through the lambda extension. Instead, set `ELASTIC_APM_LAMBDA_APM_SERVER`. For more info, see [AWS Lambda](lambda-support.md).
9898

9999

100100
## `enabled` [config-enabled]
@@ -108,7 +108,7 @@ Enable or disable the agent. When set to false, the agent will not collect any d
108108

109109
## `recording` [config-recording]
110110

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

113113
| Environment | Django/Flask | Default |
114114
| --- | --- | --- |
@@ -122,7 +122,7 @@ Enable or disable recording of events. If set to false, then the Python agent do
122122

123123
### `log_level` [config-log_level]
124124

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

127127
| Environment | Django/Flask | Default |
128128
| --- | --- | --- |
@@ -320,7 +320,7 @@ A list of exception types to be filtered. Exceptions of these types will not be
320320

321321
### `transaction_ignore_urls` [config-transaction-ignore-urls]
322322

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

325325
| Environment | Django/Flask | Default | Example |
326326
| --- | --- | --- | --- |
@@ -460,7 +460,7 @@ Especially for spans, collecting source code can have a large impact on storage
460460

461461
### `capture_body` [config-capture-body]
462462

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

465465
| Environment | Django/Flask | Default |
466466
| --- | --- | --- |
@@ -482,7 +482,7 @@ Request bodies often contain sensitive values like passwords and credit card num
482482

483483
### `capture_headers` [config-capture-headers]
484484

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

487487
| Environment | Django/Flask | Default |
488488
| --- | --- | --- |
@@ -493,14 +493,14 @@ For transactions and errors that happen due to HTTP requests, the Python agent c
493493
Possible values: `true`, `false`
494494

495495
::::{warning}
496-
Request headers often contain sensitive values like session IDs and cookies. See [sanitizing data](/reference/sanitizing-data.md) for more information on how to filter out sensitive data.
496+
Request headers often contain sensitive values like session IDs and cookies. See [sanitizing data](sanitizing-data.md) for more information on how to filter out sensitive data.
497497
::::
498498

499499

500500

501501
### `transaction_max_spans` [config-transaction-max-spans]
502502

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

505505
| Environment | Django/Flask | Default |
506506
| --- | --- | --- |
@@ -511,7 +511,7 @@ This limits the amount of spans that are recorded per transaction. This is helpf
511511

512512
### `stack_trace_limit` [config-stack-trace-limit]
513513

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

516516
| Environment | Django/Flask | Default |
517517
| --- | --- | --- |
@@ -524,7 +524,7 @@ Setting the limit to `0` will disable stack trace collection, while any positive
524524

525525
### `span_stack_trace_min_duration` [config-span-stack-trace-min-duration]
526526

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

529529
| Environment | Django/Flask | Default |
530530
| --- | --- | --- |
@@ -541,7 +541,7 @@ Except for the special values `-1` and `0`, this setting should be provided in *
541541

542542
### `span_frames_min_duration` [config-span-frames-min-duration]
543543

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

546546
| Environment | Django/Flask | Default |
547547
| --- | --- | --- |
@@ -555,7 +555,7 @@ This config value is being deprecated. Use [`span_stack_trace_min_duration`](#co
555555

556556
### `span_compression_enabled` [config-span-compression-enabled]
557557

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

560560
| Environment | Django/Flask | Default |
561561
| --- | --- | --- |
@@ -568,7 +568,7 @@ If enabled, the agent will compress very short, repeated spans into a single spa
568568

569569
### `span_compression_exact_match_max_duration` [config-span-compression-exact-match-max_duration]
570570

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

573573
| Environment | Django/Flask | Default |
574574
| --- | --- | --- |
@@ -581,7 +581,7 @@ Two spans are considered exact matches if the following attributes are identical
581581

582582
### `span_compression_same_kind_max_duration` [config-span-compression-same-kind-max-duration]
583583

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

586586
| Environment | Django/Flask | Default |
587587
| --- | --- | --- |
@@ -594,7 +594,7 @@ Two spans are considered to be of the same kind if the following attributes are
594594

595595
### `exit_span_min_duration` [config-exit-span-min-duration]
596596

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

599599
| Environment | Django/Flask | Default |
600600
| --- | --- | --- |
@@ -612,7 +612,7 @@ if a span propagates distributed tracing IDs, it will not be ignored, even if it
612612

613613
### `api_request_size` [config-api-request-size]
614614

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

617617
| Environment | Django/Flask | Default |
618618
| --- | --- | --- |
@@ -630,7 +630,7 @@ Due to internal buffering of gzip, the actual request size can be a few kilobyte
630630

631631
### `api_request_time` [config-api-request-time]
632632

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

635635
| Environment | Django/Flask | Default |
636636
| --- | --- | --- |
@@ -652,7 +652,7 @@ The actual time will vary between 90-110% of the given value, to avoid stampedes
652652
| --- | --- | --- |
653653
| `ELASTIC_APM_PROCESSORS` | `PROCESSORS` | `['elasticapm.processors.sanitize_stacktrace_locals', 'elasticapm.processors.sanitize_http_request_cookies', 'elasticapm.processors.sanitize_http_headers', 'elasticapm.processors.sanitize_http_wsgi_env', 'elasticapm.processors.sanitize_http_request_body']` |
654654

655-
A list of processors to process transactions and errors. For more information, see [Sanitizing Data](/reference/sanitizing-data.md).
655+
A list of processors to process transactions and errors. For more information, see [Sanitizing Data](sanitizing-data.md).
656656

657657
::::{warning}
658658
We recommend always including the default set of validators if you customize this setting.
@@ -662,13 +662,13 @@ We recommend always including the default set of validators if you customize thi
662662

663663
### `sanitize_field_names` [config-sanitize-field-names]
664664

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

667667
| Environment | Django/Flask | Default |
668668
| --- | --- | --- |
669669
| `ELASTIC_APM_SANITIZE_FIELD_NAMES` | `SANITIZE_FIELD_NAMES` | `["password", "passwd", "pwd", "secret", "*key", "*token*", "*session*", "*credit*", "*card*", "*auth*", "*principal*", "set-cookie"]` |
670670

671-
A list of glob-matched field names to match and mask when using processors. For more information, see [Sanitizing Data](/reference/sanitizing-data.md).
671+
A list of glob-matched field names to match and mask when using processors. For more information, see [Sanitizing Data](sanitizing-data.md).
672672

673673
::::{warning}
674674
We recommend always including the default set of field name matches if you customize this setting.
@@ -678,7 +678,7 @@ We recommend always including the default set of field name matches if you custo
678678

679679
### `transaction_sample_rate` [config-transaction-sample-rate]
680680

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

683683
| Environment | Django/Flask | Default |
684684
| --- | --- | --- |
@@ -843,7 +843,7 @@ This feature requires APM Server and Kibana >= 7.3.
843843

844844
Enable/disable the tracking and collection of metrics from `prometheus_client`.
845845

846-
See [Prometheus metric set (beta)](/reference/metrics.md#prometheus-metricset) for more information.
846+
See [Prometheus metric set (beta)](metrics.md#prometheus-metricset) for more information.
847847

848848
::::{note}
849849
This feature is currently in beta status.
@@ -859,7 +859,7 @@ This feature is currently in beta status.
859859

860860
A prefix to prepend to Prometheus metrics names.
861861

862-
See [Prometheus metric set (beta)](/reference/metrics.md#prometheus-metricset) for more information.
862+
See [Prometheus metric set (beta)](metrics.md#prometheus-metricset) for more information.
863863

864864
::::{note}
865865
This feature is currently in beta status.
@@ -875,7 +875,7 @@ This feature is currently in beta status.
875875

876876
List of import paths for the MetricSets that should be used to collect metrics.
877877

878-
See [Custom Metrics](/reference/metrics.md#custom-metrics) for more information.
878+
See [Custom Metrics](metrics.md#custom-metrics) for more information.
879879

880880

881881
### `central_config` [config-central_config]
@@ -914,7 +914,7 @@ This feature requires APM Server >= 7.2.
914914
| --- | --- | --- |
915915
| `ELASTIC_APM_DISABLE_LOG_RECORD_FACTORY` | `DISABLE_LOG_RECORD_FACTORY` | `False` |
916916

917-
By default in python 3, the agent installs a [LogRecord factory](/reference/logs.md#logging) that automatically adds tracing fields to your log records. Disable this behavior by setting this to `True`.
917+
By default in python 3, the agent installs a [LogRecord factory](logs.md#logging) that automatically adds tracing fields to your log records. Disable this behavior by setting this to `True`.
918918

919919

920920
### `use_elastic_traceparent_header` [config-use-elastic-traceparent-header]
@@ -923,14 +923,14 @@ By default in python 3, the agent installs a [LogRecord factory](/reference/logs
923923
| --- | --- | --- |
924924
| `ELASTIC_APM_USE_ELASTIC_TRACEPARENT_HEADER` | `USE_ELASTIC_TRACEPARENT_HEADER` | `True` |
925925

926-
To enable [distributed tracing](docs-content://solutions/observability/apm/traces.md), the agent sets a number of HTTP headers to outgoing requests made with [instrumented HTTP libraries](/reference/supported-technologies.md#automatic-instrumentation-http). These headers (`traceparent` and `tracestate`) are defined in the [W3C Trace Context](https://www.w3.org/TR/trace-context-1/) specification.
926+
To enable [distributed tracing](docs-content://solutions/observability/apm/traces.md), the agent sets a number of HTTP headers to outgoing requests made with [instrumented HTTP libraries](supported-technologies.md#automatic-instrumentation-http). These headers (`traceparent` and `tracestate`) are defined in the [W3C Trace Context](https://www.w3.org/TR/trace-context-1/) specification.
927927

928928
Additionally, when this setting is set to `True`, the agent will set `elasticapm-traceparent` for backwards compatibility.
929929

930930

931931
### `trace_continuation_strategy` [config-trace-continuation-strategy]
932932

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

935935
| Environment | Django/Flask | Default |
936936
| --- | --- | --- |

0 commit comments

Comments
 (0)