ASGI Middleware
Elastic Cloud Serverless projects are autoscaled environments, fully managed by Elastic and available on Elastic Cloud. Availability This functionality is generally available and ready for production usage. The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats. Availability This functionality is generally available and ready for production usage. Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes. The Elastic APM Python agent enables you to trace the execution of operations in your Python applications, sending performance metrics and errors to the Elastic APM Server. Availability This functionality is in technical preview and is ready for evaluation. Use with caution in production; it is not recommended for mission-critical workloads. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. Specific Support terms apply. This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.
Serverless Observability
Generally available
Stack
Generally available
APM Agent Python
Preview
Preview
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
Incorporating Elastic APM into your ASGI-based project only requires a few easy steps.
Several ASGI frameworks are supported natively. Please check Supported Technologies for more information
Install the Elastic APM agent using pip:
$ pip install elastic-apm
or add elastic-apm to your project’s requirements.txt file.
To set up the agent, you need to initialize it with appropriate settings.
The settings are configured either via environment variables, or as initialization arguments.
You can find a list of all available settings in the Configuration page.
To set up the APM agent, wrap your ASGI app with the ASGITracingMiddleware:
from elasticapm.contrib.asgi import ASGITracingMiddleware
app = MyGenericASGIApp()
app = ASGITracingMiddleware(app)
- depending on framework
Make sure to call elasticapm.set_transaction_name() with an appropriate transaction name in all your routes.
Currently, the agent doesn’t support automatic capturing of exceptions. You can follow progress on this issue on Github.
A list of supported Python versions can be found on our Supported Technologies page.
Elastic APM only supports asyncio when using Python 3.7+