Skip to content

Commit 686d59c

Browse files
[docs] Miscellaneous docs clean up (#2240)
* remove unused substitutions * move images * update redirected links * fix image paths
1 parent 01dcc66 commit 686d59c

8 files changed

+24
-501
lines changed

docs/docset.yml

-477
Large diffs are not rendered by default.

docs/reference/configuration.md

+20-20
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](../images/dynamic-config.svg "") ](#dynamic-configuration))
32+
* [Central configuration](#config-central_config) (supported options are marked with [![dynamic config](/reference/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](../images/dynamic-config.svg "") badge can be changed at runtime when set from a supported source.
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.
4242

4343
The Python Agent supports [Central configuration](docs-content://solutions/observability/apps/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

@@ -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](../images/dynamic-config.svg "") ](#dynamic-configuration)
111+
[![dynamic config](/reference/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](../images/dynamic-config.svg "") ](#dynamic-configuration)
125+
[![dynamic config](/reference/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](../images/dynamic-config.svg "") ](#dynamic-configuration)
323+
[![dynamic config](/reference/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](../images/dynamic-config.svg "") ](#dynamic-configuration)
463+
[![dynamic config](/reference/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](../images/dynamic-config.svg "") ](#dynamic-configuration)
485+
[![dynamic config](/reference/images/dynamic-config.svg "") ](#dynamic-configuration)
486486

487487
| Environment | Django/Flask | Default |
488488
| --- | --- | --- |
@@ -500,7 +500,7 @@ Request headers often contain sensitive values like session IDs and cookies. See
500500

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

503-
[![dynamic config](../images/dynamic-config.svg "") ](#dynamic-configuration)
503+
[![dynamic config](/reference/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](../images/dynamic-config.svg "") ](#dynamic-configuration)
514+
[![dynamic config](/reference/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](../images/dynamic-config.svg "") ](#dynamic-configuration)
527+
[![dynamic config](/reference/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](../images/dynamic-config.svg "") ](#dynamic-configuration)
544+
[![dynamic config](/reference/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](../images/dynamic-config.svg "") ](#dynamic-configuration)
558+
[![dynamic config](/reference/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](../images/dynamic-config.svg "") ](#dynamic-configuration)
571+
[![dynamic config](/reference/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](../images/dynamic-config.svg "") ](#dynamic-configuration)
584+
[![dynamic config](/reference/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](../images/dynamic-config.svg "") ](#dynamic-configuration)
597+
[![dynamic config](/reference/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](../images/dynamic-config.svg "") ](#dynamic-configuration)
615+
[![dynamic config](/reference/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](../images/dynamic-config.svg "") ](#dynamic-configuration)
633+
[![dynamic config](/reference/images/dynamic-config.svg "") ](#dynamic-configuration)
634634

635635
| Environment | Django/Flask | Default |
636636
| --- | --- | --- |
@@ -662,7 +662,7 @@ 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](../images/dynamic-config.svg "") ](#dynamic-configuration)
665+
[![dynamic config](/reference/images/dynamic-config.svg "") ](#dynamic-configuration)
666666

667667
| Environment | Django/Flask | Default |
668668
| --- | --- | --- |
@@ -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](../images/dynamic-config.svg "") ](#dynamic-configuration)
681+
[![dynamic config](/reference/images/dynamic-config.svg "") ](#dynamic-configuration)
682682

683683
| Environment | Django/Flask | Default |
684684
| --- | --- | --- |
@@ -930,7 +930,7 @@ Additionally, when this setting is set to `True`, the agent will set `elasticapm
930930

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

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

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

docs/reference/django-support.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ ELASTIC_APM = {
171171
To easily send Python `logging` messages as "error" objects to Elasticsearch, we provide a `LoggingHandler` which you can use in your logging setup. The log messages will be enriched with a stack trace, data from the request, and more.
172172

173173
::::{note}
174-
the intended use case for this handler is to send high priority log messages (e.g. log messages with level `ERROR`) to Elasticsearch. For normal log shipping, we recommend using [filebeat](beats://reference/filebeat/filebeat-overview.md).
174+
the intended use case for this handler is to send high priority log messages (e.g. log messages with level `ERROR`) to Elasticsearch. For normal log shipping, we recommend using [filebeat](beats://reference/filebeat/index.md).
175175
::::
176176

177177

File renamed without changes.

docs/reference/lambda-support.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Both the [{{apm-lambda-ext}}](apm-aws-lambda://reference/index.md) and the Pytho
2929
To add the layers to your Lambda function through the AWS Management Console:
3030

3131
1. Navigate to your function in the AWS Management Console
32-
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 "")
32+
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 "")
3333
3. Choose the *Specify an ARN* radio button
3434
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:
3535
* APM Extension layer:
@@ -44,7 +44,7 @@ To add the layers to your Lambda function through the AWS Management Console:
4444
```
4545
1. Replace `{AWS_REGION}` with the AWS region of your Lambda function.
4646
47-
![image of choosing a layer in AWS Console](../images/choose-a-layer.png "")
47+
![image of choosing a layer in AWS Console](images/choose-a-layer.png "")
4848
5. Click the *Add* button
4949
::::::
5050
@@ -159,7 +159,7 @@ ELASTIC_APM_SEND_STRATEGY = background <4>
159159
3. This is your APM secret token.
160160
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.
161161

162-
![Python environment variables configuration section in AWS Console](../images/python-lambda-env-vars.png "")
162+
![Python environment variables configuration section in AWS Console](images/python-lambda-env-vars.png "")
163163
::::::
164164

165165
::::::{tab-item} AWS CLI

0 commit comments

Comments
 (0)