Configuration

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

env.sh
export ATLAS_APIKEY="<API_KEY>"
app.py
try:
    import heimdall
    heimdall.start()
except ImportError as e:
    pass

or inside the code as:

heimdall.start(apikey="<API_KEY>")

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

Config name in code
Config name as env variable
Purpose

apikey

ATLAS_APIKEY

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

application_name

ATLAS_APPLICATION_NAME

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

application_stage

ATLAS_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.

application_version

ATLAS_APPLICATION_VERSION

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

debug

ATLAS_DEBUG_ENABLE

Set this to "True" to enable atlas debug logs.

auto_instrumentation

ATLAS_AUTO_INSTRUMENTATION_ENABLE

This is an experimental feature to automatically generate trace ids for distrubuted requests. Disabled by default. Set this to "True" to enable it.

Last updated