Configurationedit

To adapt the Elastic APM agent to your needs, you can configure it using environment variables, or framework specific configuration.

Djangoedit

To configure Django, add an ELASTIC_APM dictionary to your settings.py:

ELASTIC_APM = {
    'APP_NAME': 'my-app',
    'SECRET_TOKEN': 'changeme',
}

Flaskedit

To configure Flask, add an ELASTIC_APM dictonary to your app.config:

app.config['ELASTIC_APM'] = {
    'APP_NAME': 'my-app',
    'SECRET_TOKEN': 'changeme',
}

apm = ElasticAPM(app)

Required optionsedit

app_nameedit

The name of your app. This is used to keep all the errors and transactions of your app together and is the primary filter in the Elastic APM user interface.

server_urledit

The URL for your APM Server. The URL must be fully qualified, including protocol (http or https) and port.

transport_classedit

The transport class to use when sending events to the APM server. The default AsyncTransport uses a background thread to send data. If your environment doesn’t allow background threads, you can use elasticapm.transport.http.Transport instead. Note however that this can have adverse effects on performance.

Other optionsedit

secret_tokenedit

This string is used to ensure that only your agents can send data to your APM server. Both the agents and the APM server have to be configured with the same secret token. One example to generate a secure secret token is:

python -c "import uuid; print(str(uuid.uuid4()))"

app_versionedit

A version string for the currently deployed version of the app. If you don’t version your deployments, the recommended value for this field is the commit identifier of the deployed revision, e.g. the output of git rev-parse HEAD.

framework_nameedit

Name of the used framework. For Django and Flask, this defaults to django and flask respectively, otherwise, the default is None.

framework_versionedit

Version number of the used framework. For Django and Flask, this defaults to the used version of the framework, otherwise, the default is None.

filter_exception_typesedit

A list of exception types to be filtered. Exceptions of these types will not be sent to the APM server.

transactions_ignore_patternsedit

A list of regular expressions. Transactions that match any of the of the configured patterns will be ignored and not sent to the APM server.

timeoutedit

A timeout in seconds. If a request to the APM server takes longer than the configured timeout, the request is cancelled and the event (exception or transaction) is discarded. Set to None to disable timeouts.

hostnameedit

The host name to use when sending error and transaction data to the APM server.

auto_log_stacksedit

If set to True (the default), the agent will add a stack trace to each log event, indicating where the log message has been issued.

This setting can be overridden on an individual basis by setting the extra-key stack:

logger.info('something happened', extra={'stack': False})

traces_send_frequencyedit

Interval with which transactions should be sent to the APM server, in seconds. A lower value will increase the load on your APM server, while a higher value can increase the memory pressure of your app. A higher value also impacts the time until transactions are indexed and searchable in Elasticsearch.

max_event_queue_lengthedit

Maximum queue length of transactions before sending transactions to the APM server. A lower value will increase the load on your APM server, while a higher value can increase the memory pressure of your app. A higher value also impacts the time until transactions are indexed and searchable in Elasticsearch.

This setting is useful to limit memory consumption if you experience a sudden spike of traffic.

processorsedit

A list of processors to process transactions and errors. For more information, see Sanitizing Data.

include_pathsedit

A set of module paths that should be considered when detecting if a stacktrace frame is a library frame or an "in-app" frame. For Django, the default set is the list of INSTALLED_APPS, but without django.contrib apps. For Flask, it’s the app module.

exclude_pathsedit

A set of module paths that should be considered when excluding a frame from being detected as an in-app frame. exclude_paths takes precedence over include_paths.

For Django, the default is set to {'elasticapm', 'django'}. Everywhere else, the default is set(['elasticapm']).

debugedit

If your app is in debug mode (e.g. in Django with settings.DEBUG = True or in Flask with app.debug = True), the agent won’t send any data to the APM server. You can override it by changing this setting to True.

disable_sendedit

If set to True, the agent won’t send any events to the APM server, independent of any debug state.

disable_instrumentationedit

If set to True, the agent won’t instrument any code. This disables most of the tracing functionality, but can be useful to debug possible instrumentation issues.

verify_server_certedit

By default, the agent verifies the SSL certificate if you use an HTTPS connection to the APM server. Verification can be disabled by changing this setting to False.