Skip to content
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
1 change: 1 addition & 0 deletions docset.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ cross_links:
- apm-agent-go
- apm-agent-ios
- apm-agent-java
- apm-agent-python
- apm-agent-rum-js
- apm-aws-lambda
- apm-k8s-attacher
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -248,11 +248,11 @@ To send APM data to Elastic, you must install an APM agent and configure it to s
**Learn more in the {{apm-agent}} reference**

* [Supported technologies](asciidocalypse://docs/apm-agent-php/docs/reference/supported-technologies.md)
* [Configuration](asciidocalypse://docs/apm-agent-python/docs/reference/configuration.md)
* [Configuration](apm-agent-python://reference/configuration.md)

</div>
<div tabindex="0" role="tabpanel" id="apm-apm-get-started-python-panel" aria-labelledby="apm-apm-get-started-python-button" hidden="">
Django and Flask are two of several frameworks that the Elastic APM Python Agent supports. For a complete list of supported technologies, refer to the [Elastic APM Python Agent documentation](asciidocalypse://docs/apm-agent-python/docs/reference/supported-technologies.md).
Django and Flask are two of several frameworks that the Elastic APM Python Agent supports. For a complete list of supported technologies, refer to the [Elastic APM Python Agent documentation](apm-agent-python://reference/supported-technologies.md).

*Django*

Expand Down Expand Up @@ -337,8 +337,8 @@ To send APM data to Elastic, you must install an APM agent and configure it to s

**Learn more in the {{apm-agent}} reference**

* [Supported technologies](asciidocalypse://docs/apm-agent-python/docs/reference/supported-technologies.md)
* [Advanced configuration](asciidocalypse://docs/apm-agent-python/docs/reference/configuration.md)
* [Supported technologies](apm-agent-python://reference/supported-technologies.md)
* [Advanced configuration](apm-agent-python://reference/configuration.md)

</div>
<div tabindex="0" role="tabpanel" id="apm-apm-get-started-ruby-panel" aria-labelledby="apm-apm-get-started-ruby-button" hidden="">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Log ECS reformatting is controlled by the `log_ecs_reformatting` configuration o

* [Java](apm-agent-java://reference/config-logging.md#config-log-ecs-reformatting)
* [Ruby](asciidocalypse://docs/apm-agent-ruby/docs/reference/configuration.md#config-log-ecs-formatting)
* [Python](asciidocalypse://docs/apm-agent-python/docs/reference/configuration.md#config-log_ecs_reformatting)
* [Python](apm-agent-python://reference/configuration.md#config-log_ecs_reformatting)


### Ingest logs [observability-ecs-application-logs-ingest-logs]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,7 @@ Learn about correlating plaintext logs in the agent-specific ingestion guides:
* [Java](apm-agent-java://reference/logs.md#log-correlation-ids)
* [.NET](apm-agent-dotnet://reference/logs.md)
* [Node.js](asciidocalypse://docs/apm-agent-nodejs/docs/reference/logs.md)
* [Python](asciidocalypse://docs/apm-agent-python/docs/reference/logs.md#log-correlation-ids)
* [Python](apm-agent-python://reference/logs.md#log-correlation-ids)
* [Ruby](asciidocalypse://docs/apm-agent-ruby/docs/reference/logs.md)


Expand Down
2 changes: 1 addition & 1 deletion solutions/observability/apps/api-keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ You can now apply your newly created API keys in the configuration of each of yo
* **Java agent**: [`api_key`](apm-agent-java://reference/config-reporter.md#config-api-key)
* **Node.js agent**: [`apiKey`](asciidocalypse://docs/apm-agent-nodejs/docs/reference/configuration.md#api-key)
* **PHP agent**: [`api_key`](asciidocalypse://docs/apm-agent-php/docs/reference/configuration-reference.md#config-api-key)
* **Python agent**: [`api_key`](asciidocalypse://docs/apm-agent-python/docs/reference/configuration.md#config-api-key)
* **Python agent**: [`api_key`](apm-agent-python://reference/configuration.md#config-api-key)
* **Ruby agent**: [`api_key`](asciidocalypse://docs/apm-agent-ruby/docs/reference/configuration.md#config-api-key)


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ PHP agent
: [Configuration reference](asciidocalypse://docs/apm-agent-php/docs/reference/configuration.md)

Python agent
: [Configuration reference](asciidocalypse://docs/apm-agent-python/docs/reference/configuration.md)
: [Configuration reference](apm-agent-python://reference/configuration.md)

Ruby agent
: [Configuration reference](asciidocalypse://docs/apm-agent-ruby/docs/reference/configuration.md)
Expand Down
4 changes: 2 additions & 2 deletions solutions/observability/apps/apm-agent-tls-communication.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ If APM agents are authenticating themselves using a certificate that cannot be a
When the APM server uses a certificate that is not chained to a publicly-trusted certificate (e.g. self-signed), additional configuration is required in the {{apm-agent}}:

* **Go agent**: certificate pinning through [`ELASTIC_APM_SERVER_CERT`](apm-agent-go://reference/configuration.md#config-server-cert)
* **Python agent**: certificate pinning through [`server_cert`](asciidocalypse://docs/apm-agent-python/docs/reference/configuration.md#config-server-cert)
* **Python agent**: certificate pinning through [`server_cert`](apm-agent-python://reference/configuration.md#config-server-cert)
* **Ruby agent**: certificate pinning through [`server_ca_cert`](asciidocalypse://docs/apm-agent-ruby/docs/reference/configuration.md#config-ssl-ca-cert)
* **.NET agent**: [`ServerCert`](apm-agent-dotnet://reference/config-reporter.md#config-server-cert)
* **Node.js agent**: custom CA setting through [`serverCaCertFile`](asciidocalypse://docs/apm-agent-nodejs/docs/reference/configuration.md#server-ca-cert-file)
Expand All @@ -68,7 +68,7 @@ We do not recommend disabling {{apm-agent}} verification of the server’s certi
* **.NET agent**: [`VerifyServerCert`](apm-agent-dotnet://reference/config-reporter.md#config-verify-server-cert)
* **Java agent**: [`verify_server_cert`](apm-agent-java://reference/config-reporter.md#config-verify-server-cert)
* **PHP agent**: [`verify_server_cert`](asciidocalypse://docs/apm-agent-php/docs/reference/configuration-reference.md#config-verify-server-cert)
* **Python agent**: [`verify_server_cert`](asciidocalypse://docs/apm-agent-python/docs/reference/configuration.md#config-verify-server-cert)
* **Python agent**: [`verify_server_cert`](apm-agent-python://reference/configuration.md#config-verify-server-cert)
* **Ruby agent**: [`verify_server_cert`](asciidocalypse://docs/apm-agent-ruby/docs/reference/configuration.md#config-verify-server-cert)
* **Node.js agent**: [`verifyServerCert`](asciidocalypse://docs/apm-agent-nodejs/docs/reference/configuration.md#validate-server-cert)

Expand Down
4 changes: 2 additions & 2 deletions solutions/observability/apps/apm-server-binary.md
Original file line number Diff line number Diff line change
Expand Up @@ -600,8 +600,8 @@ apm = ElasticAPM(app)

**Learn more in the agent reference**

* [Supported technologies](asciidocalypse://docs/apm-agent-python/docs/reference/supported-technologies.md)
* [Advanced configuration](asciidocalypse://docs/apm-agent-python/docs/reference/configuration.md)
* [Supported technologies](apm-agent-python://reference/supported-technologies.md)
* [Advanced configuration](apm-agent-python://reference/configuration.md)
::::::

::::::{tab-item} Ruby
Expand Down
6 changes: 3 additions & 3 deletions solutions/observability/apps/built-in-data-filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ This setting supports [Central configuration](apm-agent-central-configuration.md
* Java: [`sanitize_field_names`](apm-agent-java://reference/config-core.md#config-sanitize-field-names)
* .NET: [`sanitizeFieldNames`](apm-agent-dotnet://reference/config-core.md#config-sanitize-field-names)
* Node.js: [`sanitizeFieldNames`](asciidocalypse://docs/apm-agent-nodejs/docs/reference/configuration.md#sanitize-field-names)
* Python: [`sanitize_field_names`](asciidocalypse://docs/apm-agent-python/docs/reference/configuration.md#config-sanitize-field-names)
* Python: [`sanitize_field_names`](apm-agent-python://reference/configuration.md#config-sanitize-field-names)
* Ruby: [`sanitize_field_names`](asciidocalypse://docs/apm-agent-ruby/docs/reference/configuration.md#config-sanitize-field-names)

Alternatively, you can completely disable the capturing of HTTP headers. This setting also supports [Central configuration](apm-agent-central-configuration.md):
Expand All @@ -37,7 +37,7 @@ Alternatively, you can completely disable the capturing of HTTP headers. This se
* Java: [`capture_headers`](apm-agent-java://reference/config-core.md#config-capture-headers)
* .NET: [`CaptureHeaders`](apm-agent-dotnet://reference/config-http.md#config-capture-headers)
* Node.js: [`captureHeaders`](asciidocalypse://docs/apm-agent-nodejs/docs/reference/configuration.md#capture-headers)
* Python: [`capture_headers`](asciidocalypse://docs/apm-agent-python/docs/reference/configuration.md#config-capture-headers)
* Python: [`capture_headers`](apm-agent-python://reference/configuration.md#config-capture-headers)
* Ruby: [`capture_headers`](asciidocalypse://docs/apm-agent-ruby/docs/reference/configuration.md#config-capture-headers)


Expand All @@ -51,7 +51,7 @@ This setting supports [Central configuration](apm-agent-central-configuration.md
* Java: [`capture_body`](apm-agent-java://reference/config-core.md#config-capture-body)
* .NET: [`CaptureBody`](apm-agent-dotnet://reference/config-http.md#config-capture-body)
* Node.js: [`captureBody`](asciidocalypse://docs/apm-agent-nodejs/docs/reference/configuration.md#capture-body)
* Python: [`capture_body`](asciidocalypse://docs/apm-agent-python/docs/reference/configuration.md#config-capture-body)
* Python: [`capture_body`](apm-agent-python://reference/configuration.md#config-capture-body)
* Ruby: [`capture_body`](asciidocalypse://docs/apm-agent-ruby/docs/reference/configuration.md#config-capture-body)


Expand Down
2 changes: 1 addition & 1 deletion solutions/observability/apps/custom-filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Refer to the relevant agent’s documentation for more information and examples:

* .NET: [Filter API](apm-agent-dotnet://reference/public-api.md#filter-api).
* Node.js: [`addFilter()`](asciidocalypse://docs/apm-agent-nodejs/docs/reference/agent-api.md#apm-add-filter).
* Python: [custom processors](asciidocalypse://docs/apm-agent-python/docs/reference/sanitizing-data.md).
* Python: [custom processors](apm-agent-python://reference/sanitizing-data.md).
* Ruby: [`add_filter()`](asciidocalypse://docs/apm-agent-ruby/docs/reference/api-reference.md#api-agent-add-filter).


Expand Down
10 changes: 5 additions & 5 deletions solutions/observability/apps/elastic-apm-agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,12 +89,12 @@ In addition to APM and error data, the Python agent also collects system and app

If you’re ready to give Elastic APM a try, see [Get started with traces and APM](../../../solutions/observability/apps/get-started-with-apm.md).

See the [Python agent reference](asciidocalypse://docs/apm-agent-python/docs/reference/index.md) for full documentation, including:
See the [Python agent reference](apm-agent-python://reference/index.md) for full documentation, including:

* [Supported technologies](asciidocalypse://docs/apm-agent-python/docs/reference/supported-technologies.md)
* [Set up](asciidocalypse://docs/apm-agent-python/docs/reference/set-up-apm-python-agent.md)
* [Configuration reference](asciidocalypse://docs/apm-agent-python/docs/reference/configuration.md)
* [API reference](asciidocalypse://docs/apm-agent-python/docs/reference/api-reference.md)
* [Supported technologies](apm-agent-python://reference/supported-technologies.md)
* [Set up](apm-agent-python://reference/set-up-apm-python-agent.md)
* [Configuration reference](apm-agent-python://reference/configuration.md)
* [API reference](apm-agent-python://reference/api-reference.md)

::::{important}
Not all APM agent configuration options are compatible with Elastic Cloud serverless.
Expand Down
2 changes: 1 addition & 1 deletion solutions/observability/apps/filter-application-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,6 @@ Service environments are defined when configuring your APM agents. It’s vital
* **.NET:** [`Environment`](apm-agent-dotnet://reference/config-core.md#config-environment)
* **Node.js:** [`environment`](asciidocalypse://docs/apm-agent-nodejs/docs/reference/ingestion-tools/apm-agent-nodejs/configuration.md#environment)
* **PHP:** [`environment`](asciidocalypse://docs/apm-agent-php/docs/reference/ingestion-tools/apm-agent-php/configuration-reference.md#config-environment)
* **Python:** [`environment`](asciidocalypse://docs/apm-agent-python/docs/reference/ingestion-tools/apm-agent-python/configuration.md#config-environment)
* **Python:** [`environment`](apm-agent-python://reference/configuration.md#config-environment)
* **Ruby:** [`environment`](asciidocalypse://docs/apm-agent-ruby/docs/reference/ingestion-tools/apm-agent-ruby/configuration.md#config-environment)
* **Real User Monitoring (Elastic Stack only):** [`environment`](apm-agent-rum-js://reference/configuration.md#environment)
4 changes: 2 additions & 2 deletions solutions/observability/apps/fleet-managed-apm-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -645,8 +645,8 @@ apm = ElasticAPM(app)

**Learn more in the agent reference**

* [Supported technologies](asciidocalypse://docs/apm-agent-python/docs/reference/supported-technologies.md)
* [Advanced configuration](asciidocalypse://docs/apm-agent-python/docs/reference/configuration.md)
* [Supported technologies](apm-agent-python://reference/supported-technologies.md)
* [Advanced configuration](apm-agent-python://reference/configuration.md)
::::::

::::::{tab-item} Ruby
Expand Down
6 changes: 3 additions & 3 deletions solutions/observability/apps/metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Avoid defining too many user-specified labels. Defining too many unique fields i
* .NET: [`SetLabel`](apm-agent-dotnet://reference/public-api.md#api-transaction-set-label)
* Node.js: [`setLabel`](asciidocalypse://docs/apm-agent-nodejs/docs/reference/agent-api.md#apm-add-labels)
* PHP: [`Transaction` `setLabel`](asciidocalypse://docs/apm-agent-php/docs/reference/public-api.md#api-transaction-interface-set-label) | [`Span` `setLabel`](asciidocalypse://docs/apm-agent-php/docs/reference/public-api.md#api-span-interface-set-label)
* Python: [`elasticapm.label()`](asciidocalypse://docs/apm-agent-python/docs/reference/api-reference.md#api-label)
* Python: [`elasticapm.label()`](apm-agent-python://reference/api-reference.md#api-label)
* Ruby: [`set_label`](asciidocalypse://docs/apm-agent-ruby/docs/reference/api-reference.md#api-agent-set-label)
* Rum: [`addLabels`](apm-agent-rum-js://reference/agent-api.md#apm-add-labels)

Expand Down Expand Up @@ -62,7 +62,7 @@ Setting a circular object, a large object, or a non JSON serializable object can
* .NET: *coming soon*
* Node.js: [`setCustomContext`](asciidocalypse://docs/apm-agent-nodejs/docs/reference/agent-api.md#apm-set-custom-context)
* PHP: *coming soon*
* Python: [`set_custom_context`](asciidocalypse://docs/apm-agent-python/docs/reference/api-reference.md#api-set-custom-context)
* Python: [`set_custom_context`](apm-agent-python://reference/api-reference.md#api-set-custom-context)
* Ruby: [`set_custom_context`](asciidocalypse://docs/apm-agent-ruby/docs/reference/api-reference.md#api-agent-set-custom-context)
* Rum: [`setCustomContext`](apm-agent-rum-js://reference/agent-api.md#apm-set-custom-context)

Expand All @@ -85,7 +85,7 @@ User context adds **indexed** user information to transactions and errors. Index
* .NET *coming soon*
* Node.js: [`setUserContext`](asciidocalypse://docs/apm-agent-nodejs/docs/reference/agent-api.md#apm-set-user-context)
* PHP: *coming soon*
* Python: [`set_user_context`](asciidocalypse://docs/apm-agent-python/docs/reference/api-reference.md#api-set-user-context)
* Python: [`set_user_context`](apm-agent-python://reference/api-reference.md#api-set-user-context)
* Ruby: [`set_user`](asciidocalypse://docs/apm-agent-ruby/docs/reference/api-reference.md#api-agent-set-user)
* Rum: [`setUserContext`](apm-agent-rum-js://reference/agent-api.md#apm-set-user-context)

2 changes: 1 addition & 1 deletion solutions/observability/apps/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ For a full list of tracked metrics, see the relevant agent documentation:
* [Go](apm-agent-go://reference/metrics.md)
* [Java](apm-agent-java://reference/metrics.md)
* [Node.js](asciidocalypse://docs/apm-agent-nodejs/docs/reference/metrics.md)
* [Python](asciidocalypse://docs/apm-agent-python/docs/reference/metrics.md)
* [Python](apm-agent-python://reference/metrics.md)
* [Ruby](asciidocalypse://docs/apm-agent-ruby/docs/reference/metrics.md)


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ By using an AWS Lambda extension, Elastic APM agents can send data to a local La
To get started with the setup of Elastic APM for your Lambda functions, checkout the language-specific guides:

* [Quick Start with APM on AWS Lambda - Node.js](asciidocalypse://docs/apm-agent-nodejs/docs/reference/lambda.md)
* [Quick Start with APM on AWS Lambda - Python](asciidocalypse://docs/apm-agent-python/docs/reference/lambda-support.md)
* [Quick Start with APM on AWS Lambda - Python](apm-agent-python://reference/lambda-support.md)
* [Quick Start with APM on AWS Lambda - Java](apm-agent-java://reference/aws-lambda.md)

Or, see the [architecture guide](apm-aws-lambda://reference/index.md) to learn more about how the extension works, performance impacts, and more.
2 changes: 1 addition & 1 deletion solutions/observability/apps/secret-token.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Each Elastic {{apm-agent}} has a configuration option to set the value of the se
* **.NET agent**: [`ELASTIC_APM_SECRET_TOKEN`](apm-agent-dotnet://reference/config-reporter.md#config-secret-token)
* **Node.js agent**: [`Secret Token`](asciidocalypse://docs/apm-agent-nodejs/docs/reference/configuration.md#secret-token)
* **PHP agent**: [`secret_token`](asciidocalypse://docs/apm-agent-php/docs/reference/configuration-reference.md#config-secret-token)
* **Python agent**: [`secret_token`](asciidocalypse://docs/apm-agent-python/docs/reference/configuration.md#config-secret-token)
* **Python agent**: [`secret_token`](apm-agent-python://reference/configuration.md#config-secret-token)
* **Ruby agent**: [`secret_token`](asciidocalypse://docs/apm-agent-ruby/docs/reference/configuration.md#config-secret-token)

In addition to setting the secret token, ensure the configured server URL uses `HTTPS` instead of `HTTP`:
Expand Down
4 changes: 2 additions & 2 deletions solutions/observability/apps/spans.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ To configure the number of spans recorded per transaction, see the relevant Agen
* .NET: [`TransactionMaxSpans`](apm-agent-dotnet://reference/config-core.md#config-transaction-max-spans)
* Node.js: [`transactionMaxSpans`](asciidocalypse://docs/apm-agent-nodejs/docs/reference/configuration.md#transaction-max-spans)
* PHP: [`transaction_max_spans`](asciidocalypse://docs/apm-agent-php/docs/reference/configuration-reference.md#config-transaction-max-spans)
* Python: [`transaction_max_spans`](asciidocalypse://docs/apm-agent-python/docs/reference/configuration.md#config-transaction-max-spans)
* Python: [`transaction_max_spans`](apm-agent-python://reference/configuration.md#config-transaction-max-spans)
* Ruby: [`transaction_max_spans`](asciidocalypse://docs/apm-agent-ruby/docs/reference/configuration.md#config-transaction-max-spans)


Expand Down Expand Up @@ -479,4 +479,4 @@ Support for span compression is available in the following agents and can be con
| **Java agent** | [`span_compression_same_kind_max_duration`](apm-agent-java://reference/config-huge-traces.md#config-span-compression-same-kind-max-duration) | [`span_compression_exact_match_max_duration`](apm-agent-java://reference/config-huge-traces.md#config-span-compression-exact-match-max-duration) |
| **.NET agent** | [`SpanCompressionSameKindMaxDuration`](apm-agent-dotnet://reference/config-core.md#config-span-compression-exact-match-max-duration) |
| **Node.js agent** | [`spanCompressionSameKindMaxDuration`](asciidocalypse://docs/apm-agent-nodejs/docs/reference/configuration.md#span-compression-exact-match-max-duration) |
| **Python agent** | [`span_compression_same_kind_max_duration`](asciidocalypse://docs/apm-agent-python/docs/reference/configuration.md#config-span-compression-exact-match-max_duration) |
| **Python agent** | [`span_compression_same_kind_max_duration`](apm-agent-python://reference/configuration.md#config-span-compression-exact-match-max_duration) |
4 changes: 2 additions & 2 deletions solutions/observability/apps/traces.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ $distDataAsString = ElasticApm::getSerializedCurrentDistributedTracingData(); <1
::::::

::::::{tab-item} Python
1. Start a transaction with [`begin_transaction()`](asciidocalypse://docs/apm-agent-python/docs/reference/api-reference.md#client-api-begin-transaction).
1. Start a transaction with [`begin_transaction()`](apm-agent-python://reference/api-reference.md#client-api-begin-transaction).
2. Get the `trace_parent` of the active transaction.
3. Send the `trace_parent` to the receiving service.

Expand Down Expand Up @@ -397,7 +397,7 @@ client.begin_transaction('processors', trace_parent=parent) <2>


::::{tip}
See the [`TraceParent` API](asciidocalypse://docs/apm-agent-python/docs/reference/api-reference.md#traceparent-api) for additional examples.
See the [`TraceParent` API](apm-agent-python://reference/api-reference.md#traceparent-api) for additional examples.
::::
::::::

Expand Down
Loading
Loading