Configuration

You can configure the behavior of our agents using these configuration options. They can be set from environment variables like:

export ATLAS_APIKEY="<API_KEY>"

or while running the code as:

java -javaagent:<path-to-agent-jar> -Datlas.apikey=<your-api-key> -jar <your-jar-file>

In the table below, you can see what each config option does and how to set them.

Except for the parameter apiKey, all other configuration options are optional and have default values.

Config name while running code
Config name as env variable
Purpose

atlas.apikey

ATLAS_APIKEY

This is the api key used to authenticate with CtrlB services.

atlas.agent.application.name

ATLAS_AGENT_APPLICATION_NAME

Set the name of your application to improve your experience. Defaults to git repo if available.

atlas.agent.application.stage

ATLAS_AGENT_APPLICATION_STAGE

Set this if the same application is deployed in prod, beta or dev environment to distinguish between them. Can leave unspecified if not applicable.

atlas.agent.application.version

ATLAS_AGENT_APPLICATION_VERSION

Set this if the same application name and stage have multiple versions running. Can leave unspecified if not applicable.

atlas.agent.log.level

ATLAS_AGENT_LOG_LEVEL

Set the log level for Java agent. Defaults to "info". Can be one of "debug", "info", "warn", "err".

Last updated