Getting Elastic APM set up for your Flask project is easy, and there are various ways you can tweak it to fit to your needs.

Install the Elastic APM agent using pip:

$ pip install "elastic-apm[flask]"

or addelastic-apm[flask] to your project’srequirements.txt file.

To set up the agent, you need to initialize it with appropriate settings.

The settings are configured either via environment variables, the application’s settings, or as initialization arguments.

You can find a list of all available settings in theConfiguration page.

To initialize the agent for your application using environment variables:

from elasticapm.contrib.flask import ElasticAPMapp = Flask(__name__)apm = ElasticAPM(app)

To configure the agent usingELASTIC_APM in your application’s settings:

from elasticapm.contrib.flask import ElasticAPMapp.config['ELASTIC_APM'] = {    'SERVICE_NAME': '<SERVICE-NAME>',    'SECRET_TOKEN': '<SECRET-TOKEN>',}apm = ElasticAPM(app)

The final option is to initialize the agent with the settings as arguments:

from elasticapm.contrib.flask import ElasticAPMapm = ElasticAPM(app, service_name='<APP-ID>', secret_token='<SECRET-TOKEN>')

To force the agent to send data while the app is in debug mode, set the value ofDEBUG in theELASTIC_APM dictionary toTrue:

app.config['ELASTIC_APM'] = {        'SERVICE_NAME': '<SERVICE-NAME>',        'SECRET_TOKEN': '<SECRET-TOKEN>',        'DEBUG': True}

You can use the agent’sinit_app hook for adding the application on the fly:

from elasticapm.contrib.flask import ElasticAPMapm = ElasticAPM()def create_app():    app = Flask(__name__)    apm.init_app(app, service_name='<SERVICE-NAME>', secret_token='<SECRET-TOKEN>')    return app

Once you have configured the agent, it will automatically track transactions and capture uncaught exceptions within Flask. If you want to send additional events, a couple of shortcuts are provided on the ElasticAPM Flask middleware object by raising an exception or logging a generic message.

Capture an arbitrary exception by callingcapture_exception:

try:    1 / 0except ZeroDivisionError:    apm.capture_exception()

Log a generic message withcapture_message:

apm.capture_message('hello, world!')

This feature has been deprecated and will be removed in a future version.

Please see ourLogging documentation for other supported ways to ship logs to Elasticsearch.

Note that you can always send exceptions and messages to the APM Server withcapture_exception and andcapture_message.

from elasticapm import get_client@app.route('/')def bar():    try:        1 / 0    except ZeroDivisionError:        get_client().capture_exception()

In addition to what the agents log by default, you can send extra information:

@app.route('/')def bar():    try:        1 / 0    except ZeroDivisionError:        app.logger.error('Math is hard',            exc_info=True,            extra={                'good_at_math': False,            }        )    )

The Elastic APM agent will automatically send errors and performance data from your Celery tasks to the APM Server.

If you’ve followed the instructions above, the agent has already hooked into the right signals and should be reporting performance metrics.

You can use theTRANSACTIONS_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:

app.config['ELASTIC_APM'] = {    ...    'TRANSACTIONS_IGNORE_PATTERNS': ['^OPTIONS ', '/api/']    ...}

This would ignore any requests using theOPTIONS method and any requests containing/api/.

To correlate performance measurement in the browser with measurements in your Flask app, you can help the RUM (Real User Monitoring) agent by configuring it with the Trace ID and Span ID of the backend request. We provide a handy template context processor which adds all the necessary bits into the context of your templates.

The context processor is installed automatically when you initializeElasticAPM. All that is left to do is to update the call to initialize the RUM agent (which probably happens in your base template) like this:

elasticApm.init({    serviceName: "my-frontend-service",    pageLoadTraceId: "{{ apm["trace_id"] }}",    pageLoadSpanId: "{{ apm["span_id"]() }}",    pageLoadSampled: {{ apm["is_sampled_js"] }}})

See theJavaScript RUM agent documentation for more information.

A list of supportedFlask andPython versions can be found on ourSupported Technologies page.