Starlette/FastAPI Support
editStarlette/FastAPI Support
editIncorporating Elastic APM into your Starlette project only requires a few easy steps.
Installation
editInstall the Elastic APM agent using pip:
$ pip install elastic-apm
or add elastic-apm
to your project’s requirements.txt
file.
Setup
editTo 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 initialize the agent for your application using environment variables:
from starlette.applications import Starlette from elasticapm.contrib.starlette import make_apm_client, ElasticAPM apm = make_apm_client() app = Starlette() app.add_middleware(ElasticAPM, client=apm)
To configure the agent using initialization arguments:
from starlette.applications import Starlette from elasticapm.contrib.starlette import make_apm_client, ElasticAPM apm = make_apm_client({ 'SERVICE_NAME': '<SERVICE-NAME>', 'SECRET_TOKEN': '<SECRET-TOKEN>', }) app = Starlette() app.add_middleware(ElasticAPM, client=apm)
FastAPI
editBecause FastAPI supports Starlette middleware, using the agent with FastAPI is almost exactly the same as with Starlette:
from fastapi import FastAPI from elasticapm.contrib.starlette import make_apm_client, ElasticAPM apm = make_apm_client() app = FastAPI() app.add_middleware(ElasticAPM, client=apm)
Usage
editOnce you have configured the agent, it will automatically track transactions and capture uncaught exceptions within starlette.
Capture an arbitrary exception by calling
capture_exception
:
try: 1 / 0 except ZeroDivisionError: apm.client.capture_exception()
Log a generic message with capture_message
:
apm.client.capture_message('hello, world!')
Performance metrics
editIf you’ve followed the instructions above, the agent has installed our instrumentation middleware which will process all requests through your app. This will measure response times, as well as detailed performance data for all supported technologies.
Due to the fact that asyncio
drivers are usually separate from their
synchronous counterparts, specific instrumentation is needed for all drivers.
The support for asynchronous drivers is currently quite limited.
Ignoring specific routes
editYou can use the
TRANSACTIONS_IGNORE_PATTERNS
configuration option to ignore specific routes. The list given should be a
list of regular expressions which are matched against the transaction name:
apm = make_apm_client({ # ... 'TRANSACTIONS_IGNORE_PATTERNS': ['^GET /secret', '/extra_secret'] # ... })
This would ignore any requests using the GET /secret
route
and any requests containing /extra_secret
.
Supported Starlette and Python versions
editA list of supported Starlette and Python versions can be found on our Supported Technologies page.
Elastic APM only supports asyncio
when using Python 3.7+