Skip to content

[docs] Miscellaneous docs clean up #2240

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Mar 25, 2025
Merged

[docs] Miscellaneous docs clean up #2240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f0ab51c
remove unused substitutions
colleenmcginnis Mar 20, 2025
4853f11
move images
colleenmcginnis Mar 20, 2025
70a0ad1
update redirected links
colleenmcginnis Mar 20, 2025
32c2355
fix image paths
colleenmcginnis Mar 20, 2025
be9c435
Merge branch 'main' into docs-clean-up
colleenmcginnis Mar 25, 2025
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
477 changes: 0 additions & 477 deletions docs/docset.yml
View file
Open in desktop

Large diffs are not rendered by default.

40 changes: 20 additions & 20 deletions docs/reference/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ ELASTIC_APM = {

The precedence is as follows:

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

## Dynamic configuration [dynamic-configuration]

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

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).

Expand Down Expand Up @@ -108,7 +108,7 @@ Enable or disable the agent. When set to false, the agent will not collect any d

## `recording` [config-recording]

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

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

### `log_level` [config-log_level]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

| Environment | Django/Flask | Default |
| --- | --- | --- |
Expand Down Expand Up @@ -662,7 +662,7 @@ We recommend always including the default set of validators if you customize thi

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

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

| Environment | Django/Flask | Default |
| --- | --- | --- |
Expand All @@ -678,7 +678,7 @@ We recommend always including the default set of field name matches if you custo

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

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

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

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

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

| Environment | Django/Flask | Default |
| --- | --- | --- |
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/django-support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ ELASTIC_APM = {
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.

::::{note}
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).
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).
::::


Expand Down
0 docs/images/choose-a-layer.png → docs/reference/images/choose-a-layer.png
View file
Open in desktop
File renamed without changes
0 docs/images/config-layer.png → docs/reference/images/config-layer.png
View file
Open in desktop
File renamed without changes
0 docs/images/dynamic-config.svg → docs/reference/images/dynamic-config.svg
View file
Open in desktop
File renamed without changes
0 docs/images/python-lambda-env-vars.png → ...ference/images/python-lambda-env-vars.png
View file
Open in desktop
File renamed without changes
6 changes: 3 additions & 3 deletions docs/reference/lambda-support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Both the [{{apm-lambda-ext}}](apm-aws-lambda://reference/index.md) and the Pytho
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 All @@ -44,7 +44,7 @@ To add the layers to your Lambda function through the AWS Management Console:
```
1. Replace `{AWS_REGION}` with the AWS region of your Lambda function.

![image of choosing a layer in AWS Console](../images/choose-a-layer.png "")
![image of choosing a layer in AWS Console](images/choose-a-layer.png "")
5. Click the *Add* button
::::::

Expand Down Expand Up @@ -159,7 +159,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.

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

::::::{tab-item} AWS CLI
Expand Down
Loading