Set up the Agentedit

There are three different ways to set up the Elastic APM Java Agent:

Configurationedit

Once you’ve set up the Agent, see the configuration guide on how to configure Elastic APM.

SSL/TLS communication with APM Serveredit

If SSL/TLS communication is enabled on the APM Server, make sure to check out the SSL setup guide.

Monitoring AWS Lambda Functions (Experimental)edit

Learn how to set up AWS Lambda functions tracing in our Lambda setup guide.

Using with Security Manager enablededit

The agent should work as expected on JVMs with an enabled SecurityManager, provided that it is granted with java.security.AllPermission. Make sure that the following snippet is added to an effective* policy (replace with the real path** to the agent jar):

grant codeBase "file:</path/to/elastic-apm-agent.jar>" {
    permission java.security.AllPermission;
};

If you see a java.lang.SecurityException exception (for example a - java.security.AccessControlException) after verifying the above grant snippet is effectively applied, open an issue in our GitHub repo with a description and the full stack trace.

* it is possible to have multiple policy files taking effect at the same time on a single JVM. The policy entry above can be added to an existing policy or can be appended through the java.security.policy system property. See documentation for more details.

** you can make use of the property expansion capability for specifying the agent jar path.

Supported technologiesedit

Please check supported technologies for details on if the Elastic APM agent supports auto-instrumentation of the technologies your application is using.

Bootstrap checksedit

In some cases, the agent needs to take a decision to abort very early, before almost any initialization process takes place, for example- when it is attached to a non-supported JVM version. This decision is based on what we call "bootstrap checks". If any of the bootstrap checks fails, the agent will log an error to the standard error stream and abort. It is possible to disable bootstrap checks by setting the elastic.apm.disable_bootstrap_checks System property, or the ELASTIC_APM_DISABLE_BOOTSTRAP_CHECKS environment variable, to true.

JVM Filteringedit

In some cases, users may cast a too-wide net to instrument their Java processes, for example when setting the JAVA_TOOL_OPTIONS environment variable globally on a host/container on which many JVMs run. In such cases, users may want to exclude JVMs from being instrumented, or to specifically allow when necessary. For this purpose, we have the following bootstrap configuration options available:

The allowlist option expects a comma-separated list of wild-card patterns. Such patterns may contain wildcards (*), which match 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. The patterns are matched against the JVM command as it is stored in the sun.java.command system property.

Some examples: