Loading

Profiling configuration options

If enabled, the apm agent will correlate it’s transaction with the profiling data from elastic universal profiling running on the same host.

Default Type Dynamic
false Boolean false
Java System Properties Property file Environment
elastic.apm.universal_profiling_integration_enabled universal_profiling_integration_enabled ELASTIC_APM_UNIVERSAL_PROFILING_INTEGRATION_ENABLED

The feature needs to buffer ended local-root spans for a short duration to ensure that all of its profiling data has been received.This configuration option configures the buffer size in number of spans. The higher the number of local root spans per second, the higher this buffer size should be set. The agent will log a warning if it is not capable of buffering a span due to insufficient buffer size. This will cause the span to be exported immediately instead with possibly incomplete profiling correlation data.

Default Type Dynamic
4096 Integer false
Java System Properties Property file Environment
elastic.apm.universal_profiling_integration_buffer_size universal_profiling_integration_buffer_size ELASTIC_APM_UNIVERSAL_PROFILING_INTEGRATION_BUFFER_SIZE

The extension needs to bind a socket to a file for communicating with the universal profiling host agent.This configuration option can be used to change the location. Note that the total path name (including the socket) must not exceed 100 characters due to OS restrictions. If unset, the value of the java.io.tmpdir system property will be used.

Default Type Dynamic
<none> String false
Java System Properties Property file Environment
elastic.apm.universal_profiling_integration_socket_dir universal_profiling_integration_socket_dir ELASTIC_APM_UNIVERSAL_PROFILING_INTEGRATION_SOCKET_DIR
Note

This feature is currently experimental, which means it is disabled by default and it is not guaranteed to be backwards compatible in future releases.

Set to true to make the agent create spans for method executions based on async-profiler, a sampling aka statistical profiler.

Due to the nature of how sampling profilers work, the duration of the inferred spans are not exact, but only estimations. The profiling_inferred_spans_sampling_interval lets you fine tune the trade-off between accuracy and overhead.

The inferred spans are created after a profiling session has ended. This means there is a delay between the regular and the inferred spans being visible in the UI.

Only platform threads are supported. Virtual threads are not supported and will not be profiled.

Note

This feature is not available on Windows and on OpenJ9

dynamic config

Default Type Dynamic
false Boolean true
Java System Properties Property file Environment
elastic.apm.profiling_inferred_spans_enabled profiling_inferred_spans_enabled ELASTIC_APM_PROFILING_INFERRED_SPANS_ENABLED

By default, async profiler prints warning messages about missing JVM symbols to standard output. Set this option to false to suppress such messages

dynamic config

Default Type Dynamic
true Boolean true
Java System Properties Property file Environment
elastic.apm.profiling_inferred_spans_logging_enabled profiling_inferred_spans_logging_enabled ELASTIC_APM_PROFILING_INFERRED_SPANS_LOGGING_ENABLED

The frequency at which stack traces are gathered within a profiling session. The lower you set it, the more accurate the durations will be. This comes at the expense of higher overhead and more spans for potentially irrelevant operations. The minimal duration of a profiling-inferred span is the same as the value of this setting.

dynamic config

Supports the duration suffixes ms, s and m. Example: 50ms.

Default Type Dynamic
50ms TimeDuration true
Java System Properties Property file Environment
elastic.apm.profiling_inferred_spans_sampling_interval profiling_inferred_spans_sampling_interval ELASTIC_APM_PROFILING_INFERRED_SPANS_SAMPLING_INTERVAL

The minimum duration of an inferred span. Note that the min duration is also implicitly set by the sampling interval. However, increasing the sampling interval also decreases the accuracy of the duration of inferred spans.

dynamic config

Supports the duration suffixes ms, s and m. Example: 0ms.

Default Type Dynamic
0ms TimeDuration true
Java System Properties Property file Environment
elastic.apm.profiling_inferred_spans_min_duration profiling_inferred_spans_min_duration ELASTIC_APM_PROFILING_INFERRED_SPANS_MIN_DURATION

If set, the agent will only create inferred spans for methods which match this list. Setting a value may slightly reduce overhead and can reduce clutter by only creating spans for the classes you are interested in. Example: org.example.myapp.*

This option supports the wildcard *, which matches zero or more characters. Examples: /foo/*/bar/*/baz*, *foo*. Matching is case insensitive by default. Prepending an element with (?-i) makes the matching case sensitive.

dynamic config

Default Type Dynamic
* List true
Java System Properties Property file Environment
elastic.apm.profiling_inferred_spans_included_classes profiling_inferred_spans_included_classes ELASTIC_APM_PROFILING_INFERRED_SPANS_INCLUDED_CLASSES

Excludes classes for which no profiler-inferred spans should be created.

This option supports the wildcard *, which matches zero or more characters. Examples: /foo/*/bar/*/baz*, *foo*. Matching is case insensitive by default. Prepending an element with (?-i) makes the matching case sensitive.

dynamic config

Default Type Dynamic
(?-i)java.*, (?-i)javax.*, (?-i)sun.*, (?-i)com.sun.*, (?-i)jdk.*, (?-i)org.apache.tomcat.*, (?-i)org.apache.catalina.*, (?-i)org.apache.coyote.*, (?-i)org.jboss.as.*, (?-i)org.glassfish.*, (?-i)org.eclipse.jetty.*, (?-i)com.ibm.websphere.*, (?-i)io.undertow.* List true
Java System Properties Property file Environment
elastic.apm.profiling_inferred_spans_excluded_classes profiling_inferred_spans_excluded_classes ELASTIC_APM_PROFILING_INFERRED_SPANS_EXCLUDED_CLASSES

Profiling requires that the async-profiler shared library is exported to a temporary location and loaded by the JVM. The partition backing this location must be executable, however in some server-hardened environments, noexec may be set on the standard /tmp partition, leading to java.lang.UnsatisfiedLinkError errors. Set this property to an alternative directory (e.g. /var/tmp) to resolve this. If unset, the value of the java.io.tmpdir system property will be used.

Default Type Dynamic
<none> String false
Java System Properties Property file Environment
elastic.apm.profiling_inferred_spans_lib_directory profiling_inferred_spans_lib_directory ELASTIC_APM_PROFILING_INFERRED_SPANS_LIB_DIRECTORY