From 34b137bc50ad12f1a3bd1e9098207845b5890bf4 Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri Benedetti Date: Fri, 29 Aug 2025 12:58:38 +0200 Subject: [PATCH 1/6] Add applies_to metadata --- docs/reference/advanced-topics.md | 10 +++ docs/reference/aiohttp-server-support.md | 10 +++ docs/reference/api-reference.md | 98 ++++++++++++++++----- docs/reference/asgi-middleware.md | 10 +++ docs/reference/azure-functions-support.md | 10 +++ docs/reference/configuration.md | 10 +++ docs/reference/django-support.md | 10 +++ docs/reference/flask-support.md | 10 +++ docs/reference/how-agent-works.md | 10 +++ docs/reference/index.md | 10 +++ docs/reference/instrumenting-custom-code.md | 10 +++ docs/reference/lambda-support.md | 10 +++ docs/reference/logs.md | 10 +++ docs/reference/metrics.md | 10 +++ docs/reference/opentelemetry-api-bridge.md | 10 +++ docs/reference/performance-tuning.md | 10 +++ docs/reference/run-tests-locally.md | 10 +++ docs/reference/sanic-support.md | 10 +++ docs/reference/sanitizing-data.md | 10 +++ docs/reference/set-up-apm-python-agent.md | 10 +++ docs/reference/starlette-support.md | 10 +++ docs/reference/supported-technologies.md | 10 +++ docs/reference/tornado-support.md | 10 +++ docs/reference/upgrading-4-x.md | 10 +++ docs/reference/upgrading-5-x.md | 10 +++ docs/reference/upgrading-6-x.md | 10 +++ docs/reference/upgrading.md | 10 +++ docs/reference/wrapper-support.md | 10 +++ docs/release-notes/breaking-changes.md | 11 +++ docs/release-notes/deprecations.md | 10 +++ docs/release-notes/index.md | 10 +++ docs/release-notes/known-issues.md | 10 +++ 32 files changed, 388 insertions(+), 21 deletions(-) diff --git a/docs/reference/advanced-topics.md b/docs/reference/advanced-topics.md index aade7f2df..74ae91b5a 100644 --- a/docs/reference/advanced-topics.md +++ b/docs/reference/advanced-topics.md @@ -1,6 +1,16 @@ --- 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 +products: + - id: cloud-serverless + - id: observability + - id: apm --- # Advanced topics [advanced-topics] diff --git a/docs/reference/aiohttp-server-support.md b/docs/reference/aiohttp-server-support.md index fcde2cdab..06e3c296d 100644 --- a/docs/reference/aiohttp-server-support.md +++ b/docs/reference/aiohttp-server-support.md @@ -1,6 +1,16 @@ --- 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 +products: + - id: cloud-serverless + - id: observability + - id: apm --- # Aiohttp Server support [aiohttp-server-support] diff --git a/docs/reference/api-reference.md b/docs/reference/api-reference.md index 63ddbb58f..0eb0212fa 100644 --- a/docs/reference/api-reference.md +++ b/docs/reference/api-reference.md @@ -1,6 +1,16 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/api.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga +products: + - id: cloud-serverless + - id: observability + - id: apm --- # API reference [api] @@ -15,7 +25,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 +48,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 +65,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 +91,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 +130,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 +149,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 +175,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 +191,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 +207,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 +223,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 +238,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 +256,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 +274,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 +317,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 +332,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 +347,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 +362,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 +393,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 +414,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 +449,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 +489,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..b3b261c4b 100644 --- a/docs/reference/asgi-middleware.md +++ b/docs/reference/asgi-middleware.md @@ -1,6 +1,16 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/asgi-middleware.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga +products: + - id: cloud-serverless + - id: observability + - id: apm --- # ASGI Middleware [asgi-middleware] diff --git a/docs/reference/azure-functions-support.md b/docs/reference/azure-functions-support.md index 44a62416f..a9cb82e1f 100644 --- a/docs/reference/azure-functions-support.md +++ b/docs/reference/azure-functions-support.md @@ -1,6 +1,16 @@ --- 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 +products: + - id: cloud-serverless + - id: observability + - id: apm --- # Monitoring Azure Functions [azure-functions-support] diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md index d95df439b..b4bfd00c2 100644 --- a/docs/reference/configuration.md +++ b/docs/reference/configuration.md @@ -1,6 +1,16 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/configuration.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga +products: + - id: cloud-serverless + - id: observability + - id: apm --- # Configuration [configuration] diff --git a/docs/reference/django-support.md b/docs/reference/django-support.md index 37b1fe3bd..442c1eb57 100644 --- a/docs/reference/django-support.md +++ b/docs/reference/django-support.md @@ -1,6 +1,16 @@ --- 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 +products: + - id: cloud-serverless + - id: observability + - id: apm --- # Django support [django-support] diff --git a/docs/reference/flask-support.md b/docs/reference/flask-support.md index 3d9fa0ad4..b143f5662 100644 --- a/docs/reference/flask-support.md +++ b/docs/reference/flask-support.md @@ -1,6 +1,16 @@ --- 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 +products: + - id: cloud-serverless + - id: observability + - id: apm --- # Flask support [flask-support] diff --git a/docs/reference/how-agent-works.md b/docs/reference/how-agent-works.md index 6c0f597ca..cedf44fb0 100644 --- a/docs/reference/how-agent-works.md +++ b/docs/reference/how-agent-works.md @@ -1,6 +1,16 @@ --- 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 +products: + - id: cloud-serverless + - id: observability + - id: apm --- # How the Agent works [how-the-agent-works] diff --git a/docs/reference/index.md b/docs/reference/index.md index 9e7eed840..6c8cc58d8 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -2,6 +2,16 @@ 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 +products: + - id: cloud-serverless + - id: observability + - id: apm --- # APM Python agent [getting-started] diff --git a/docs/reference/instrumenting-custom-code.md b/docs/reference/instrumenting-custom-code.md index 851dee965..a4859c3ab 100644 --- a/docs/reference/instrumenting-custom-code.md +++ b/docs/reference/instrumenting-custom-code.md @@ -1,6 +1,16 @@ --- 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 +products: + - id: cloud-serverless + - id: observability + - id: apm --- # Instrumenting custom code [instrumenting-custom-code] diff --git a/docs/reference/lambda-support.md b/docs/reference/lambda-support.md index 6d6799287..ebb53ce62 100644 --- a/docs/reference/lambda-support.md +++ b/docs/reference/lambda-support.md @@ -1,6 +1,16 @@ --- 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 +products: + - id: cloud-serverless + - id: observability + - id: apm 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..dc7fc2939 100644 --- a/docs/reference/logs.md +++ b/docs/reference/logs.md @@ -1,6 +1,16 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/logs.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga +products: + - id: cloud-serverless + - id: observability + - id: apm --- # Logs [logs] diff --git a/docs/reference/metrics.md b/docs/reference/metrics.md index 4f1ff2b27..b87a833e3 100644 --- a/docs/reference/metrics.md +++ b/docs/reference/metrics.md @@ -1,6 +1,16 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/metrics.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga +products: + - id: cloud-serverless + - id: observability + - id: apm --- # Metrics [metrics] diff --git a/docs/reference/opentelemetry-api-bridge.md b/docs/reference/opentelemetry-api-bridge.md index 1d7c3e6f9..39ea7e937 100644 --- a/docs/reference/opentelemetry-api-bridge.md +++ b/docs/reference/opentelemetry-api-bridge.md @@ -1,6 +1,16 @@ --- 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 +products: + - id: cloud-serverless + - id: observability + - id: apm --- # OpenTelemetry API Bridge [opentelemetry-bridge] diff --git a/docs/reference/performance-tuning.md b/docs/reference/performance-tuning.md index 04ce10e64..fe74192e0 100644 --- a/docs/reference/performance-tuning.md +++ b/docs/reference/performance-tuning.md @@ -1,6 +1,16 @@ --- 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 +products: + - id: cloud-serverless + - id: observability + - id: apm --- # Performance tuning [tuning-and-overhead] diff --git a/docs/reference/run-tests-locally.md b/docs/reference/run-tests-locally.md index f72432d7e..8b213a2fd 100644 --- a/docs/reference/run-tests-locally.md +++ b/docs/reference/run-tests-locally.md @@ -1,6 +1,16 @@ --- 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 +products: + - id: cloud-serverless + - id: observability + - id: apm --- # Run Tests Locally [run-tests-locally] diff --git a/docs/reference/sanic-support.md b/docs/reference/sanic-support.md index 515bf6837..669f5956b 100644 --- a/docs/reference/sanic-support.md +++ b/docs/reference/sanic-support.md @@ -1,6 +1,16 @@ --- 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 +products: + - id: cloud-serverless + - id: observability + - id: apm --- # Sanic Support [sanic-support] diff --git a/docs/reference/sanitizing-data.md b/docs/reference/sanitizing-data.md index b41d89148..81daa7229 100644 --- a/docs/reference/sanitizing-data.md +++ b/docs/reference/sanitizing-data.md @@ -1,6 +1,16 @@ --- 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 +products: + - id: cloud-serverless + - id: observability + - id: apm --- # 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..33425b81f 100644 --- a/docs/reference/set-up-apm-python-agent.md +++ b/docs/reference/set-up-apm-python-agent.md @@ -1,6 +1,16 @@ --- 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 +products: + - id: cloud-serverless + - id: observability + - id: apm --- # Set up the APM Python Agent [set-up] diff --git a/docs/reference/starlette-support.md b/docs/reference/starlette-support.md index 673ab79db..31a756e0f 100644 --- a/docs/reference/starlette-support.md +++ b/docs/reference/starlette-support.md @@ -1,6 +1,16 @@ --- 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 +products: + - id: cloud-serverless + - id: observability + - id: apm --- # Starlette/FastAPI Support [starlette-support] diff --git a/docs/reference/supported-technologies.md b/docs/reference/supported-technologies.md index ad768b2cb..39ef7f7ac 100644 --- a/docs/reference/supported-technologies.md +++ b/docs/reference/supported-technologies.md @@ -1,6 +1,16 @@ --- 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 +products: + - id: cloud-serverless + - id: observability + - id: apm --- # Supported technologies [supported-technologies] diff --git a/docs/reference/tornado-support.md b/docs/reference/tornado-support.md index bae66762b..534eaca25 100644 --- a/docs/reference/tornado-support.md +++ b/docs/reference/tornado-support.md @@ -1,6 +1,16 @@ --- 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 +products: + - id: cloud-serverless + - id: observability + - id: apm --- # Tornado Support [tornado-support] diff --git a/docs/reference/upgrading-4-x.md b/docs/reference/upgrading-4-x.md index 9a1cbdbd6..eb15da885 100644 --- a/docs/reference/upgrading-4-x.md +++ b/docs/reference/upgrading-4-x.md @@ -1,6 +1,16 @@ --- 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 +products: + - id: cloud-serverless + - id: observability + - id: apm --- # 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..2015a95a2 100644 --- a/docs/reference/upgrading-5-x.md +++ b/docs/reference/upgrading-5-x.md @@ -1,6 +1,16 @@ --- 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 +products: + - id: cloud-serverless + - id: observability + - id: apm --- # 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..41ced969c 100644 --- a/docs/reference/upgrading-6-x.md +++ b/docs/reference/upgrading-6-x.md @@ -1,6 +1,16 @@ --- 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 +products: + - id: cloud-serverless + - id: observability + - id: apm --- # Upgrading to version 6 of the agent [upgrading-6-x] diff --git a/docs/reference/upgrading.md b/docs/reference/upgrading.md index 83ae39902..b642bbd28 100644 --- a/docs/reference/upgrading.md +++ b/docs/reference/upgrading.md @@ -1,6 +1,16 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/upgrading.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga +products: + - id: cloud-serverless + - id: observability + - id: apm --- # Upgrading [upgrading] diff --git a/docs/reference/wrapper-support.md b/docs/reference/wrapper-support.md index a8f01bbbc..e8ceb4255 100644 --- a/docs/reference/wrapper-support.md +++ b/docs/reference/wrapper-support.md @@ -1,6 +1,16 @@ --- mapped_pages: - https://www.elastic.co/guide/en/apm/agent/python/current/wrapper-support.html +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga +products: + - id: cloud-serverless + - id: observability + - id: apm --- # Wrapper Support [wrapper-support] diff --git a/docs/release-notes/breaking-changes.md b/docs/release-notes/breaking-changes.md index 26a31362b..e2bb2880c 100644 --- a/docs/release-notes/breaking-changes.md +++ b/docs/release-notes/breaking-changes.md @@ -1,8 +1,19 @@ --- navigation_title: "Breaking changes" +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga +products: + - id: cloud-serverless + - id: observability + - id: apm --- # 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..607f98de1 100644 --- a/docs/release-notes/deprecations.md +++ b/docs/release-notes/deprecations.md @@ -1,5 +1,15 @@ --- navigation_title: "Deprecations" +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga +products: + - id: cloud-serverless + - id: observability + - id: apm --- # 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..769002cf3 100644 --- a/docs/release-notes/index.md +++ b/docs/release-notes/index.md @@ -3,6 +3,16 @@ 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 +products: + - id: cloud-serverless + - id: observability + - id: apm --- # 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..eb0cb800a 100644 --- a/docs/release-notes/known-issues.md +++ b/docs/release-notes/known-issues.md @@ -1,5 +1,15 @@ --- navigation_title: "Known issues" +applies_to: + stack: + serverless: + observability: + product: + apm_agent_python: ga +products: + - id: cloud-serverless + - id: observability + - id: apm --- # Elastic APM Python Agent known issues [elastic-apm-python-agent-known-issues] From dae19673cb11544fb7226027beab2b27ceee597a Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri Benedetti Date: Fri, 5 Sep 2025 16:10:18 +0200 Subject: [PATCH 2/6] Remove products --- docs/reference/advanced-topics.md | 4 ---- docs/reference/aiohttp-server-support.md | 4 ---- docs/reference/api-reference.md | 4 ---- docs/reference/asgi-middleware.md | 4 ---- docs/reference/azure-functions-support.md | 4 ---- docs/reference/configuration.md | 4 ---- docs/reference/django-support.md | 4 ---- docs/reference/flask-support.md | 4 ---- docs/reference/how-agent-works.md | 4 ---- docs/reference/index.md | 4 ---- docs/reference/instrumenting-custom-code.md | 4 ---- docs/reference/logs.md | 4 ---- docs/reference/metrics.md | 4 ---- docs/reference/opentelemetry-api-bridge.md | 4 ---- docs/reference/performance-tuning.md | 4 ---- docs/reference/run-tests-locally.md | 4 ---- docs/reference/sanic-support.md | 4 ---- docs/reference/sanitizing-data.md | 4 ---- docs/reference/set-up-apm-python-agent.md | 4 ---- docs/reference/starlette-support.md | 4 ---- docs/reference/supported-technologies.md | 4 ---- docs/reference/tornado-support.md | 4 ---- docs/reference/upgrading-4-x.md | 4 ---- docs/reference/upgrading-5-x.md | 4 ---- docs/reference/upgrading-6-x.md | 4 ---- docs/reference/upgrading.md | 4 ---- docs/reference/wrapper-support.md | 4 ---- docs/release-notes/breaking-changes.md | 4 ---- docs/release-notes/deprecations.md | 4 ---- docs/release-notes/index.md | 4 ---- 30 files changed, 120 deletions(-) diff --git a/docs/reference/advanced-topics.md b/docs/reference/advanced-topics.md index 74ae91b5a..1f251c886 100644 --- a/docs/reference/advanced-topics.md +++ b/docs/reference/advanced-topics.md @@ -7,10 +7,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # Advanced topics [advanced-topics] diff --git a/docs/reference/aiohttp-server-support.md b/docs/reference/aiohttp-server-support.md index 06e3c296d..77e8c25e3 100644 --- a/docs/reference/aiohttp-server-support.md +++ b/docs/reference/aiohttp-server-support.md @@ -7,10 +7,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # Aiohttp Server support [aiohttp-server-support] diff --git a/docs/reference/api-reference.md b/docs/reference/api-reference.md index 0eb0212fa..aba676e80 100644 --- a/docs/reference/api-reference.md +++ b/docs/reference/api-reference.md @@ -7,10 +7,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # API reference [api] diff --git a/docs/reference/asgi-middleware.md b/docs/reference/asgi-middleware.md index b3b261c4b..c785a0088 100644 --- a/docs/reference/asgi-middleware.md +++ b/docs/reference/asgi-middleware.md @@ -7,10 +7,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # ASGI Middleware [asgi-middleware] diff --git a/docs/reference/azure-functions-support.md b/docs/reference/azure-functions-support.md index a9cb82e1f..a2571bb6e 100644 --- a/docs/reference/azure-functions-support.md +++ b/docs/reference/azure-functions-support.md @@ -7,10 +7,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # Monitoring Azure Functions [azure-functions-support] diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md index b4bfd00c2..5934f3b6e 100644 --- a/docs/reference/configuration.md +++ b/docs/reference/configuration.md @@ -7,10 +7,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # Configuration [configuration] diff --git a/docs/reference/django-support.md b/docs/reference/django-support.md index 442c1eb57..61e5991ae 100644 --- a/docs/reference/django-support.md +++ b/docs/reference/django-support.md @@ -7,10 +7,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # Django support [django-support] diff --git a/docs/reference/flask-support.md b/docs/reference/flask-support.md index b143f5662..06f29712c 100644 --- a/docs/reference/flask-support.md +++ b/docs/reference/flask-support.md @@ -7,10 +7,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # Flask support [flask-support] diff --git a/docs/reference/how-agent-works.md b/docs/reference/how-agent-works.md index cedf44fb0..d6d6f447c 100644 --- a/docs/reference/how-agent-works.md +++ b/docs/reference/how-agent-works.md @@ -7,10 +7,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # How the Agent works [how-the-agent-works] diff --git a/docs/reference/index.md b/docs/reference/index.md index 6c8cc58d8..e92d5fff1 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -8,10 +8,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # APM Python agent [getting-started] diff --git a/docs/reference/instrumenting-custom-code.md b/docs/reference/instrumenting-custom-code.md index a4859c3ab..43b7ff14b 100644 --- a/docs/reference/instrumenting-custom-code.md +++ b/docs/reference/instrumenting-custom-code.md @@ -7,10 +7,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # Instrumenting custom code [instrumenting-custom-code] diff --git a/docs/reference/logs.md b/docs/reference/logs.md index dc7fc2939..22fbde3a3 100644 --- a/docs/reference/logs.md +++ b/docs/reference/logs.md @@ -7,10 +7,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # Logs [logs] diff --git a/docs/reference/metrics.md b/docs/reference/metrics.md index b87a833e3..af4222c0b 100644 --- a/docs/reference/metrics.md +++ b/docs/reference/metrics.md @@ -7,10 +7,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # Metrics [metrics] diff --git a/docs/reference/opentelemetry-api-bridge.md b/docs/reference/opentelemetry-api-bridge.md index 39ea7e937..704d86ab5 100644 --- a/docs/reference/opentelemetry-api-bridge.md +++ b/docs/reference/opentelemetry-api-bridge.md @@ -7,10 +7,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # OpenTelemetry API Bridge [opentelemetry-bridge] diff --git a/docs/reference/performance-tuning.md b/docs/reference/performance-tuning.md index fe74192e0..6ff228baf 100644 --- a/docs/reference/performance-tuning.md +++ b/docs/reference/performance-tuning.md @@ -7,10 +7,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # Performance tuning [tuning-and-overhead] diff --git a/docs/reference/run-tests-locally.md b/docs/reference/run-tests-locally.md index 8b213a2fd..758209217 100644 --- a/docs/reference/run-tests-locally.md +++ b/docs/reference/run-tests-locally.md @@ -7,10 +7,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # Run Tests Locally [run-tests-locally] diff --git a/docs/reference/sanic-support.md b/docs/reference/sanic-support.md index 669f5956b..2b5b37a09 100644 --- a/docs/reference/sanic-support.md +++ b/docs/reference/sanic-support.md @@ -7,10 +7,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # Sanic Support [sanic-support] diff --git a/docs/reference/sanitizing-data.md b/docs/reference/sanitizing-data.md index 81daa7229..5797e427c 100644 --- a/docs/reference/sanitizing-data.md +++ b/docs/reference/sanitizing-data.md @@ -7,10 +7,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # 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 33425b81f..8ed82bc59 100644 --- a/docs/reference/set-up-apm-python-agent.md +++ b/docs/reference/set-up-apm-python-agent.md @@ -7,10 +7,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # Set up the APM Python Agent [set-up] diff --git a/docs/reference/starlette-support.md b/docs/reference/starlette-support.md index 31a756e0f..fcffa08f3 100644 --- a/docs/reference/starlette-support.md +++ b/docs/reference/starlette-support.md @@ -7,10 +7,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # Starlette/FastAPI Support [starlette-support] diff --git a/docs/reference/supported-technologies.md b/docs/reference/supported-technologies.md index 39ef7f7ac..437928d6f 100644 --- a/docs/reference/supported-technologies.md +++ b/docs/reference/supported-technologies.md @@ -7,10 +7,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # Supported technologies [supported-technologies] diff --git a/docs/reference/tornado-support.md b/docs/reference/tornado-support.md index 534eaca25..6a7530b95 100644 --- a/docs/reference/tornado-support.md +++ b/docs/reference/tornado-support.md @@ -7,10 +7,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # Tornado Support [tornado-support] diff --git a/docs/reference/upgrading-4-x.md b/docs/reference/upgrading-4-x.md index eb15da885..40ddc547b 100644 --- a/docs/reference/upgrading-4-x.md +++ b/docs/reference/upgrading-4-x.md @@ -7,10 +7,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # 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 2015a95a2..cabf9616a 100644 --- a/docs/reference/upgrading-5-x.md +++ b/docs/reference/upgrading-5-x.md @@ -7,10 +7,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # 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 41ced969c..df1c59acd 100644 --- a/docs/reference/upgrading-6-x.md +++ b/docs/reference/upgrading-6-x.md @@ -7,10 +7,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # Upgrading to version 6 of the agent [upgrading-6-x] diff --git a/docs/reference/upgrading.md b/docs/reference/upgrading.md index b642bbd28..28f424b99 100644 --- a/docs/reference/upgrading.md +++ b/docs/reference/upgrading.md @@ -7,10 +7,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # Upgrading [upgrading] diff --git a/docs/reference/wrapper-support.md b/docs/reference/wrapper-support.md index e8ceb4255..498f05030 100644 --- a/docs/reference/wrapper-support.md +++ b/docs/reference/wrapper-support.md @@ -7,10 +7,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # Wrapper Support [wrapper-support] diff --git a/docs/release-notes/breaking-changes.md b/docs/release-notes/breaking-changes.md index e2bb2880c..bcf8c5410 100644 --- a/docs/release-notes/breaking-changes.md +++ b/docs/release-notes/breaking-changes.md @@ -6,10 +6,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # Elastic APM Python Agent breaking changes [elastic-apm-python-agent-breaking-changes] diff --git a/docs/release-notes/deprecations.md b/docs/release-notes/deprecations.md index 607f98de1..b2c14f742 100644 --- a/docs/release-notes/deprecations.md +++ b/docs/release-notes/deprecations.md @@ -6,10 +6,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # 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 769002cf3..0424a4b5c 100644 --- a/docs/release-notes/index.md +++ b/docs/release-notes/index.md @@ -9,10 +9,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # Elastic APM Python Agent release notes [elastic-apm-python-agent-release-notes] From 814fcf86a41396c6aff44f6404ba986241b2e4dd Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Fri, 5 Sep 2025 19:00:53 +0200 Subject: [PATCH 3/6] Update docs/reference/wrapper-support.md Co-authored-by: Colleen McGinnis --- docs/reference/wrapper-support.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/wrapper-support.md b/docs/reference/wrapper-support.md index 498f05030..db054a598 100644 --- a/docs/reference/wrapper-support.md +++ b/docs/reference/wrapper-support.md @@ -6,7 +6,7 @@ applies_to: serverless: observability: product: - apm_agent_python: ga + apm_agent_python: preview --- # Wrapper Support [wrapper-support] From d9e80ab624bf9e02853f774b5ef1d3adbf4ec0cb Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Fri, 5 Sep 2025 19:01:01 +0200 Subject: [PATCH 4/6] Update docs/reference/asgi-middleware.md Co-authored-by: Colleen McGinnis --- docs/reference/asgi-middleware.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/asgi-middleware.md b/docs/reference/asgi-middleware.md index c785a0088..ef33234ec 100644 --- a/docs/reference/asgi-middleware.md +++ b/docs/reference/asgi-middleware.md @@ -6,7 +6,7 @@ applies_to: serverless: observability: product: - apm_agent_python: ga + apm_agent_python: preview --- # ASGI Middleware [asgi-middleware] From 742f42d0b218dce3932aca59da5cabaa71259122 Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Fri, 5 Sep 2025 19:01:07 +0200 Subject: [PATCH 5/6] Update docs/reference/lambda-support.md Co-authored-by: Colleen McGinnis --- docs/reference/lambda-support.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/reference/lambda-support.md b/docs/reference/lambda-support.md index ebb53ce62..ada302cd6 100644 --- a/docs/reference/lambda-support.md +++ b/docs/reference/lambda-support.md @@ -7,10 +7,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm sub: apm-lambda-ext-v: ver-1-5-7 apm-python-v: ver-6-23-0 From 28427b48db5624aa18f96b2e3e7d75514606451a Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Fri, 5 Sep 2025 19:01:14 +0200 Subject: [PATCH 6/6] Update docs/release-notes/known-issues.md Co-authored-by: Colleen McGinnis --- docs/release-notes/known-issues.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/release-notes/known-issues.md b/docs/release-notes/known-issues.md index eb0cb800a..4972fdbc9 100644 --- a/docs/release-notes/known-issues.md +++ b/docs/release-notes/known-issues.md @@ -6,10 +6,6 @@ applies_to: observability: product: apm_agent_python: ga -products: - - id: cloud-serverless - - id: observability - - id: apm --- # Elastic APM Python Agent known issues [elastic-apm-python-agent-known-issues]