diff --git a/docs/reference/advanced-topics.md b/docs/reference/advanced-topics.md index aade7f2df..1f251c886 100644 --- a/docs/reference/advanced-topics.md +++ b/docs/reference/advanced-topics.md @@ -1,6 +1,12 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/advanced-topics.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga --- # Advanced topics [advanced-topics] diff --git a/docs/reference/aiohttp-server-support.md b/docs/reference/aiohttp-server-support.md index fcde2cdab..77e8c25e3 100644 --- a/docs/reference/aiohttp-server-support.md +++ b/docs/reference/aiohttp-server-support.md @@ -1,6 +1,12 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/aiohttp-server-support.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga --- # Aiohttp Server support [aiohttp-server-support] diff --git a/docs/reference/api-reference.md b/docs/reference/api-reference.md index 63ddbb58f..aba676e80 100644 --- a/docs/reference/api-reference.md +++ b/docs/reference/api-reference.md @@ -1,6 +1,12 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/api.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga --- # API reference [api] @@ -15,7 +21,9 @@ The public Client API consists of several methods on the `Client` class. This AP ### Instantiation [client-api-init] -Added in v1.0.0. +```{applies_to} +apm_agent_python: ga 1.0.0 +``` To create a `Client` instance, import it and call its constructor: @@ -36,7 +44,9 @@ framework integrations like [Django](/reference/django-support.md) and [Flask](/ #### `elasticapm.get_client()` [api-get-client] -[small]#Added in v6.1.0. +```{applies_to} +apm_agent_python: ga 6.1.0 +``` Retrieves the `Client` singleton. This is useful for many framework integrations, where the client is instantiated automatically. @@ -51,7 +61,11 @@ client.capture_message('foo') #### `Client.capture_exception()` [client-api-capture-exception] -Added in v1.0.0. `handled` added in v2.0.0. +```{applies_to} +apm_agent_python: ga 1.0.0 +``` + +`handled` added in v2.0.0. Captures an exception object: @@ -73,7 +87,9 @@ Returns the id of the error as a string. #### `Client.capture_message()` [client-api-capture-message] -Added in v1.0.0. +```{applies_to} +apm_agent_python: ga 1.0.0 +``` Captures a message with optional added contextual data. Example: @@ -110,7 +126,11 @@ Either the `message` or the `param_message` argument is required. #### `Client.begin_transaction()` [client-api-begin-transaction] -Added in v1.0.0. `trace_parent` support added in v5.6.0. +```{applies_to} +apm_agent_python: ga 1.0.0 +``` + +`trace_parent` support added in v5.6.0. Begin tracking a transaction. Should be called e.g. at the beginning of a request or when starting a background task. Example: @@ -125,7 +145,9 @@ client.begin_transaction('processors') #### `Client.end_transaction()` [client-api-end-transaction] -Added in v1.0.0. +```{applies_to} +apm_agent_python: ga 1.0.0 +``` End tracking the transaction. Should be called e.g. at the end of a request or when ending a background task. Example: @@ -149,7 +171,9 @@ Transactions can be started with a `TraceParent` object. This creates a transact #### `elasticapm.trace_parent_from_string()` [api-traceparent-from-string] -Added in v5.6.0. +```{applies_to} +apm_agent_python: ga 5.6.0 +``` Create a `TraceParent` object from the string representation generated by `TraceParent.to_string()`: @@ -163,7 +187,9 @@ client.begin_transaction('processors', trace_parent=parent) #### `elasticapm.trace_parent_from_headers()` [api-traceparent-from-headers] -Added in v5.6.0. +```{applies_to} +apm_agent_python: ga 5.6.0 +``` Create a `TraceParent` object from HTTP headers (usually generated by another Elastic APM agent): @@ -177,7 +203,9 @@ client.begin_transaction('processors', trace_parent=parent) #### `elasticapm.get_trace_parent_header()` [api-traceparent-get-header] -Added in v5.10.0. +```{applies_to} +apm_agent_python: ga 5.10.0 +``` Return the string representation of the current transaction `TraceParent` object: @@ -191,7 +219,9 @@ elasticapm.get_trace_parent_header() ### `elasticapm.instrument()` [api-elasticapm-instrument] -Added in v1.0.0. +```{applies_to} +apm_agent_python: ga 1.0.0 +``` Instruments libraries automatically. This includes a wide range of standard library and 3rd party modules. A list of instrumented modules can be found in `elasticapm.instrumentation.register`. This function should be called as early as possibly in the startup of your application. For [supported frameworks](/reference/supported-technologies.md#framework-support), this is called automatically. Example: @@ -204,7 +234,9 @@ elasticapm.instrument() ### `elasticapm.set_transaction_name()` [api-set-transaction-name] -Added in v1.0.0. +```{applies_to} +apm_agent_python: ga 1.0.0 +``` Set the name of the current transaction. For supported frameworks, the transaction name is determined automatically, and can be overridden using this function. Example: @@ -220,7 +252,9 @@ elasticapm.set_transaction_name('myapp.billing_process') ### `elasticapm.set_transaction_result()` [api-set-transaction-result] -Added in v2.2.0. +```{applies_to} +apm_agent_python: ga 2.2.0 +``` Set the result of the current transaction. For supported frameworks, the transaction result is determined automatically, and can be overridden using this function. Example: @@ -236,7 +270,9 @@ elasticapm.set_transaction_result('SUCCESS') ### `elasticapm.set_transaction_outcome()` [api-set-transaction-outcome] -Added in v5.9.0. +```{applies_to} +apm_agent_python: ga 5.9.0 +``` Sets the outcome of the transaction. The value can either be `"success"`, `"failure"` or `"unknown"`. This should only be called at the end of a transaction after the outcome is determined. @@ -277,7 +313,9 @@ elasticapm.set_transaction_outcome(OUTCOME.UNKNOWN) ### `elasticapm.get_transaction_id()` [api-get-transaction-id] -Added in v5.2.0. +```{applies_to} +apm_agent_python: ga 5.2.0 +``` Get the id of the current transaction. Example: @@ -290,7 +328,9 @@ transaction_id = elasticapm.get_transaction_id() ### `elasticapm.get_trace_id()` [api-get-trace-id] -Added in v5.2.0. +```{applies_to} +apm_agent_python: ga 5.2.0 +``` Get the `trace_id` of the current transaction’s trace. Example: @@ -303,7 +343,9 @@ trace_id = elasticapm.get_trace_id() ### `elasticapm.get_span_id()` [api-get-span-id] -Added in v5.2.0. +```{applies_to} +apm_agent_python: ga 5.2.0 +``` Get the id of the current span. Example: @@ -316,7 +358,9 @@ span_id = elasticapm.get_span_id() ### `elasticapm.set_custom_context()` [api-set-custom-context] -Added in v2.0.0. +```{applies_to} +apm_agent_python: ga 2.0.0 +``` Attach custom contextual data to the current transaction and errors. Supported frameworks will automatically attach information about the HTTP request and the logged in user. You can attach further data using this function. @@ -345,7 +389,9 @@ Errors that happen after this call will also have the custom context attached to ### `elasticapm.set_user_context()` [api-set-user-context] -Added in v2.0.0. +```{applies_to} +apm_agent_python: ga 2.0.0 +``` Attach information about the currently logged in user to the current transaction and errors. Example: @@ -364,7 +410,9 @@ Errors that happen after this call will also have the user context attached to t ### `elasticapm.capture_span` [api-capture-span] -Added in v4.1.0. +```{applies_to} +apm_agent_python: ga 4.1.0 +``` Capture a custom span. This can be used either as a function decorator or as a context manager (in a `with` statement). When used as a decorator, the name of the span will be set to the name of the function. When used as a context manager, a name has to be provided. @@ -397,7 +445,9 @@ def coffee_maker(strength): ### `elasticapm.async_capture_span` [api-async-capture-span] -Added in v5.4.0. +```{applies_to} +apm_agent_python: ga 5.4.0 +``` Capture a custom async-aware span. This can be used either as a function decorator or as a context manager (in an `async with` statement). When used as a decorator, the name of the span will be set to the name of the function. When used as a context manager, a name has to be provided. @@ -435,7 +485,9 @@ async def coffee_maker(strength): ### `elasticapm.label()` [api-label] -Added in v5.0.0. +```{applies_to} +apm_agent_python: ga 5.0.0 +``` Attach labels to the the current transaction and errors. diff --git a/docs/reference/asgi-middleware.md b/docs/reference/asgi-middleware.md index 852f12565..ef33234ec 100644 --- a/docs/reference/asgi-middleware.md +++ b/docs/reference/asgi-middleware.md @@ -1,6 +1,12 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/asgi-middleware.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: preview --- # ASGI Middleware [asgi-middleware] diff --git a/docs/reference/azure-functions-support.md b/docs/reference/azure-functions-support.md index 44a62416f..a2571bb6e 100644 --- a/docs/reference/azure-functions-support.md +++ b/docs/reference/azure-functions-support.md @@ -1,6 +1,12 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/azure-functions-support.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga --- # Monitoring Azure Functions [azure-functions-support] diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md index d95df439b..5934f3b6e 100644 --- a/docs/reference/configuration.md +++ b/docs/reference/configuration.md @@ -1,6 +1,12 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/configuration.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga --- # Configuration [configuration] diff --git a/docs/reference/django-support.md b/docs/reference/django-support.md index 37b1fe3bd..61e5991ae 100644 --- a/docs/reference/django-support.md +++ b/docs/reference/django-support.md @@ -1,6 +1,12 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/django-support.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga --- # Django support [django-support] diff --git a/docs/reference/flask-support.md b/docs/reference/flask-support.md index 3d9fa0ad4..06f29712c 100644 --- a/docs/reference/flask-support.md +++ b/docs/reference/flask-support.md @@ -1,6 +1,12 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/flask-support.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga --- # Flask support [flask-support] diff --git a/docs/reference/how-agent-works.md b/docs/reference/how-agent-works.md index 6c0f597ca..d6d6f447c 100644 --- a/docs/reference/how-agent-works.md +++ b/docs/reference/how-agent-works.md @@ -1,6 +1,12 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/how-the-agent-works.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga --- # How the Agent works [how-the-agent-works] diff --git a/docs/reference/index.md b/docs/reference/index.md index 9e7eed840..e92d5fff1 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -2,6 +2,12 @@ mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/getting-started.html - https://www.elastic.co/guide/en/apm/agent/python/current/index.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga --- # APM Python agent [getting-started] diff --git a/docs/reference/instrumenting-custom-code.md b/docs/reference/instrumenting-custom-code.md index 851dee965..43b7ff14b 100644 --- a/docs/reference/instrumenting-custom-code.md +++ b/docs/reference/instrumenting-custom-code.md @@ -1,6 +1,12 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/instrumenting-custom-code.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga --- # Instrumenting custom code [instrumenting-custom-code] diff --git a/docs/reference/lambda-support.md b/docs/reference/lambda-support.md index 6d6799287..ada302cd6 100644 --- a/docs/reference/lambda-support.md +++ b/docs/reference/lambda-support.md @@ -1,6 +1,12 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/lambda-support.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga sub: apm-lambda-ext-v: ver-1-5-7 apm-python-v: ver-6-23-0 diff --git a/docs/reference/logs.md b/docs/reference/logs.md index 18a4f0803..22fbde3a3 100644 --- a/docs/reference/logs.md +++ b/docs/reference/logs.md @@ -1,6 +1,12 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/logs.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga --- # Logs [logs] diff --git a/docs/reference/metrics.md b/docs/reference/metrics.md index 4f1ff2b27..af4222c0b 100644 --- a/docs/reference/metrics.md +++ b/docs/reference/metrics.md @@ -1,6 +1,12 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/metrics.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga --- # Metrics [metrics] diff --git a/docs/reference/opentelemetry-api-bridge.md b/docs/reference/opentelemetry-api-bridge.md index 1d7c3e6f9..704d86ab5 100644 --- a/docs/reference/opentelemetry-api-bridge.md +++ b/docs/reference/opentelemetry-api-bridge.md @@ -1,6 +1,12 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/opentelemetry-bridge.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga --- # OpenTelemetry API Bridge [opentelemetry-bridge] diff --git a/docs/reference/performance-tuning.md b/docs/reference/performance-tuning.md index 04ce10e64..6ff228baf 100644 --- a/docs/reference/performance-tuning.md +++ b/docs/reference/performance-tuning.md @@ -1,6 +1,12 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/tuning-and-overhead.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga --- # Performance tuning [tuning-and-overhead] diff --git a/docs/reference/run-tests-locally.md b/docs/reference/run-tests-locally.md index f72432d7e..758209217 100644 --- a/docs/reference/run-tests-locally.md +++ b/docs/reference/run-tests-locally.md @@ -1,6 +1,12 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/run-tests-locally.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga --- # Run Tests Locally [run-tests-locally] diff --git a/docs/reference/sanic-support.md b/docs/reference/sanic-support.md index 7b0ea5b3c..953527a22 100644 --- a/docs/reference/sanic-support.md +++ b/docs/reference/sanic-support.md @@ -1,6 +1,12 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/sanic-support.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga --- # Sanic Support [sanic-support] diff --git a/docs/reference/sanitizing-data.md b/docs/reference/sanitizing-data.md index b41d89148..5797e427c 100644 --- a/docs/reference/sanitizing-data.md +++ b/docs/reference/sanitizing-data.md @@ -1,6 +1,12 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/sanitizing-data.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga --- # Sanitizing data [sanitizing-data] diff --git a/docs/reference/set-up-apm-python-agent.md b/docs/reference/set-up-apm-python-agent.md index a74e45208..8ed82bc59 100644 --- a/docs/reference/set-up-apm-python-agent.md +++ b/docs/reference/set-up-apm-python-agent.md @@ -1,6 +1,12 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/set-up.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga --- # Set up the APM Python Agent [set-up] diff --git a/docs/reference/starlette-support.md b/docs/reference/starlette-support.md index 673ab79db..fcffa08f3 100644 --- a/docs/reference/starlette-support.md +++ b/docs/reference/starlette-support.md @@ -1,6 +1,12 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/starlette-support.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga --- # Starlette/FastAPI Support [starlette-support] diff --git a/docs/reference/supported-technologies.md b/docs/reference/supported-technologies.md index ad768b2cb..437928d6f 100644 --- a/docs/reference/supported-technologies.md +++ b/docs/reference/supported-technologies.md @@ -1,6 +1,12 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/supported-technologies.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga --- # Supported technologies [supported-technologies] diff --git a/docs/reference/tornado-support.md b/docs/reference/tornado-support.md index bae66762b..6a7530b95 100644 --- a/docs/reference/tornado-support.md +++ b/docs/reference/tornado-support.md @@ -1,6 +1,12 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/tornado-support.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga --- # Tornado Support [tornado-support] diff --git a/docs/reference/upgrading-4-x.md b/docs/reference/upgrading-4-x.md index 9a1cbdbd6..40ddc547b 100644 --- a/docs/reference/upgrading-4-x.md +++ b/docs/reference/upgrading-4-x.md @@ -1,6 +1,12 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/upgrading-4.x.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga --- # Upgrading to version 4 of the agent [upgrading-4-x] diff --git a/docs/reference/upgrading-5-x.md b/docs/reference/upgrading-5-x.md index b124841dd..cabf9616a 100644 --- a/docs/reference/upgrading-5-x.md +++ b/docs/reference/upgrading-5-x.md @@ -1,6 +1,12 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/upgrading-5.x.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga --- # Upgrading to version 5 of the agent [upgrading-5-x] diff --git a/docs/reference/upgrading-6-x.md b/docs/reference/upgrading-6-x.md index 36b8a3393..df1c59acd 100644 --- a/docs/reference/upgrading-6-x.md +++ b/docs/reference/upgrading-6-x.md @@ -1,6 +1,12 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/upgrading-6.x.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga --- # Upgrading to version 6 of the agent [upgrading-6-x] diff --git a/docs/reference/upgrading.md b/docs/reference/upgrading.md index 83ae39902..28f424b99 100644 --- a/docs/reference/upgrading.md +++ b/docs/reference/upgrading.md @@ -1,6 +1,12 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/upgrading.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga --- # Upgrading [upgrading] diff --git a/docs/reference/wrapper-support.md b/docs/reference/wrapper-support.md index a8f01bbbc..db054a598 100644 --- a/docs/reference/wrapper-support.md +++ b/docs/reference/wrapper-support.md @@ -1,6 +1,12 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/wrapper-support.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: preview --- # Wrapper Support [wrapper-support] diff --git a/docs/release-notes/breaking-changes.md b/docs/release-notes/breaking-changes.md index 26a31362b..bcf8c5410 100644 --- a/docs/release-notes/breaking-changes.md +++ b/docs/release-notes/breaking-changes.md @@ -1,8 +1,15 @@ --- navigation_title: "Breaking changes" +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga --- # Elastic APM Python Agent breaking changes [elastic-apm-python-agent-breaking-changes] + Before you upgrade, carefully review the Elastic APM RPython Agent breaking changes and take the necessary steps to mitigate any issues. % To learn how to upgrade, check out . diff --git a/docs/release-notes/deprecations.md b/docs/release-notes/deprecations.md index 6efab6863..b2c14f742 100644 --- a/docs/release-notes/deprecations.md +++ b/docs/release-notes/deprecations.md @@ -1,5 +1,11 @@ --- navigation_title: "Deprecations" +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga --- # Elastic APM Python Agent deprecations [elastic-apm-python-agent-deprecations] diff --git a/docs/release-notes/index.md b/docs/release-notes/index.md index 42c84cb88..0424a4b5c 100644 --- a/docs/release-notes/index.md +++ b/docs/release-notes/index.md @@ -3,6 +3,12 @@ navigation_title: "Elastic APM Python Agent" mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/release-notes-6.x.html - https://www.elastic.co/guide/en/apm/agent/python/current/release-notes.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga --- # Elastic APM Python Agent release notes [elastic-apm-python-agent-release-notes] diff --git a/docs/release-notes/known-issues.md b/docs/release-notes/known-issues.md index cc6f71b04..4972fdbc9 100644 --- a/docs/release-notes/known-issues.md +++ b/docs/release-notes/known-issues.md @@ -1,5 +1,11 @@ --- navigation_title: "Known issues" +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga --- # Elastic APM Python Agent known issues [elastic-apm-python-agent-known-issues]