Customizing Java APM Agent

You can customize the agent behaviour through Java runtime options.

# Example
java -javaagent:atatus-java-agent.jar -Datatus.license_key="****" -Datatus.app_name="Java App" -Datatus.service_version=1.0.0 -jar my-app.jar

Configurations

You can set following configurations in the Java agent.

All above configurations will have a prefix atatus. as follows.

-Datatus.license_key=APM_LIC_KEY

-Datatus.app_name="YOUR_APP_NAME"

-Datatus.service_version=1.2.0

-Datatus.environment=Production

-Datatus.capture_body=all

-Datatus.capture_body_ignore_urls="/login,/signup,/card/*,*/password-reset"

-Datatus.ignore_urls="/health*,/ping,*/internal/*"

-Datatus.log_level=Debug

-Datatus.ignore_status_codes="404,429,503"

-Datatus.enabled=false

-Datatus.enabled=false

-Dhttps.proxyHost=127.0.0.1
-Dhttps.proxyPort=8888

Setting app version

If you use a version to identify releases of your app, you can send it to Atatus. It is highly recommended to set service_version.

// In Properties
-Datatus.service_version=1.2.0

// Environment
export ATATUS_SERVICE_VERSION=1.2.0

Setting environment

If you are tracking multiple environments with a single APM project, then you can set a environment as follows.

// In Properties
-Datatus.environment=Production

// Environment
export ATATUS_ENVIRONMENT=Production

Enable Capture Body

This capture body option is disabled by default. If you want to see the request body in traces, you can enable this option in startup options. The body will be captured only in follwing content-types: application/x-www-form-urlencoded, text/*, application/json, application/xml.

// In Properties
-Datatus.capture_body=all

// Environment
export ATATUS_CAPTURE_BODY=all

Ignore Capture Body Urls

Using this option, you can avoid capturing request body for the list of URLs. This way, you can avoid sending sensitive data to Atatus. The ignore URLs can be either string or Regex.

-Datatus.capture_body_ignore_urls="/login,/signup,/card/*,*/password-reset"

Ignore Urls

Using this option, you can exclude specific URLs from being monitored by Atatus. For example, you may not want to monitor certain endpoints such as health, ping, heartbeat or internals. Ignore URLs can be either string or Regex.

// In Properties
-Datatus.ignore_urls="/health*,/ping,*/internal/*"

// Environment
export ATATUS_IGNORE_URLS="/health*,/ping,*/internal/*"

Enable debug log level

In case if you are facing any issues with Java APM (Example: no data is coming, crashing the server, etc), you can enable the debug log level in jvm options and send the logs to success@atatus.com. The available log levels are Error, Warn, Info, Debug.

// In Properties
-Datatus.log_level=Debug

// Environment
export ATATUS_LOG_LEVEL=Debug

Ignore status codes

Using this option, you can add list of status codes that you don't want to see in the error metrics.

This option accepts comma separated 4XX and 5XX status codes.

-Datatus.ignore_status_codes="404,429,503"

Set application package path

You can set your application package path to find exact source line in Java Exceptions.

-Datatus.application_packages="<YOUR_PACKAGE_PATH>"

example:
-Datatus.application_packages="org.example,org.another.example"

Disable agent

Using this option, you can completely disable the agent, including instrumentation and remote config polling. You can set enabled option to false to disable agent.

// In Properties
-Datatus.enabled=false

// Environment
export ATATUS_ENABLED=false

Proxy URL

You can set up the Atatus Java Agent to connect to a proxy, then the proxy can connect to Atatus Server through the firewall.

HTTPS Proxy:

// In Properties
-Dhttps.proxyHost=127.0.0.1
-Dhttps.proxyPort=8888

HTTP Proxy:

// In Properties
-Dhttp.proxyHost=127.0.0.1
-Dhttp.proxyPort=8888