CtrlB
  • CtrlB Flow
    • 🖐️Introducing CtrlB Flow
    • 🏁Getting started
    • Getting data in CtrlB Flow
    • Explore your data
    • Control your data
  • CtrlB Live Debug
    • 🖐️Introducing CtrlB Live Debug
      • What can you do with CtrlB?
      • How CtrlB works?
    • 🏁Getting started in 2 minutes
    • Plugins
      • Visual Studio Code
      • PyCharm, IntelliJ & WebStorm
    • Agents
      • Python
        • Installation
        • Configuration
        • System Requirements
        • Data Redaction
        • Troubleshoot / Release Notes
          • Version 1.0
      • NodeJs
        • Installation
        • Configuration
        • System Requirements
        • Data Redaction
        • Troubleshoot / Release Notes
          • Version 1.0
      • Java
        • Installation
        • Run with IntelliJ
        • Configuration
        • System Requirements
        • Data Redaction
        • Troubleshoot / Release Notes
      • Go
        • Installation
        • Run with Goland
        • Run with Docker
        • Configuration
        • System Requirements
        • Data Redaction
    • 🎛️Conditional Expressions
    • 🏭Deploy within your firewall
    • 🍉Benchmarking impact on your system
      • Java
      • Go
    • Benchmarking impact on your system:
Powered by GitBook
On this page
  1. CtrlB Live Debug
  2. Agents
  3. Python

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.

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

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.

PreviousInstallationNextSystem Requirements

Last updated 1 year ago