HTTP configuration optionsedit

capture_bodyedit

For transactions that are HTTP requests, the Java agent can optionally capture the request body (e.g. POST variables).

If the request has a body and this setting is disabled, the body will be shown as [REDACTED].

This option is case-insensitive. NOTE: Currently, only application/x-www-form-urlencoded (form parameters) are supported. Forms which include a file upload (multipart/form-data) are not supported.

Warning

request bodies often contain sensitive values like passwords, credit card numbers etc.If your service handles data like this, we advise to only enable this feature with care.

Valid options: off, errors, transactions, all

Default Type Dynamic

OFF

EventType

true

Java System Properties Property file Environment

elastic.apm.capture_body

capture_body

ELASTIC_APM_CAPTURE_BODY

ignore_urlsedit

Used to restrict requests to certain URLs from being instrumented.

This property should be set to an array containing one or more strings. When an incoming HTTP request is detected, its URL will be tested against each element in this list.

Note

A wildcard expression may either contain a single wildcard in the middle or have wildcards at the beginning and/or the end. Legal: *foo*, foo*, *foo, foo*bar*. Illegal: foo*bar*, foo*bar*baz. Prepending an element with (?i) makes the matching case-insensitive.

Note

All errors that are captured during a request to an ignored URL are still sent to the APM Server regardless of this setting.

Default Type Dynamic

/VAADIN/*, (?i)/heartbeat/*, /favicon.ico, *.js, *.css, *.jpg, *.jpeg, *.png, *.webp, *.svg, *.woff, *.woff2

List

true

Java System Properties Property file Environment

elastic.apm.ignore_urls

ignore_urls

ELASTIC_APM_IGNORE_URLS

ignore_user_agentsedit

Used to restrict requests from certain User-Agents from being instrumented.

When an incoming HTTP request is detected, the User-Agent from the request headers will be tested against each element in this list. Example: curl/*, (?i)*pingdom*

Note

A wildcard expression may either contain a single wildcard in the middle or have wildcards at the beginning and/or the end. Legal: *foo*, foo*, *foo, foo*bar*. Illegal: foo*bar*, foo*bar*baz. Prepending an element with (?i) makes the matching case-insensitive.

Note

All errors that are captured during a request by an ignored user agent are still sent to the APM Server regardless of this setting.

Default Type Dynamic

<none>

List

true

Java System Properties Property file Environment

elastic.apm.ignore_user_agents

ignore_user_agents

ELASTIC_APM_IGNORE_USER_AGENTS

use_path_as_transaction_nameedit

If set to true, transaction names of unsupported Servlet API-based frameworks will be in the form of $method $path instead of just $method.

Warning

If your URLs contain path parameters like /user/$userId, you should be very careful when enabling this flag, as it can lead to an explosion of transaction groups. Take a look at the url_groups option on how to mitigate this problem by grouping URLs together.

Default Type Dynamic

false

Boolean

false

Java System Properties Property file Environment

elastic.apm.use_path_as_transaction_name

use_path_as_transaction_name

ELASTIC_APM_USE_PATH_AS_TRANSACTION_NAME

url_groupsedit

This option is only considered, when use_path_as_transaction_name is active.

With this option, you can group several URL paths together by using a wildcard expression like /user/*.

Note

A wildcard expression may either contain a single wildcard in the middle or have wildcards at the beginning and/or the end. Legal: *foo*, foo*, *foo, foo*bar*. Illegal: foo*bar*, foo*bar*baz. Prepending an element with (?i) makes the matching case-insensitive.

Default Type Dynamic

<none>

List

true

Java System Properties Property file Environment

elastic.apm.url_groups

url_groups

ELASTIC_APM_URL_GROUPS