LogoLogo
Reliability HubAPI DocsPlatform
  • Welcome to Steadybit
  • Quick Start
    • First Steps
    • Compatibility
    • Install Agent and Extensions
    • Run an Experiment
    • Deploy Example Application
  • Concepts
    • Actions
    • Discovery
    • Query Language
  • Install and Configure
    • Install Agent
      • Architecture
      • Install on Kubernetes
      • Install on Linux Hosts
      • Install using Docker Compose
      • Install on Amazon ECS
      • Extension Registration
      • Using Mutual TLS for Extensions
      • Configuration Options
      • Agent State
      • Agent API
    • Install On-Prem Platform
      • Install on Minikube
      • Advanced Agent Authentication
      • Configuration Options
      • Maintenance & Incident Support
      • Syncing Teams via OIDC Attribute
    • Manage Environments
    • Manage Teams and Users
      • Users
      • Teams
      • Permissions
    • Manage Experiment Templates
  • Use Steadybit
    • Experiments
      • Design
      • Run
      • Run History
      • Schedule
      • Variables
      • Emergency Stop
      • Share
        • Templates
        • Duplicate
        • File
      • OpenTelemetry Integration
    • Explorer
      • Landscape
      • Targets
      • Advice
    • Reporting
  • Integrate with Steadybit
    • Extensions
      • Anatomy of an Extension
      • Extension Installation
      • Extension Kits
      • Available Extensions
    • API
      • Interactive API Documentation
    • CLI
    • Badges
    • Webhooks
      • Custom Webhooks
      • Preflight Webhooks
    • Preflight Actions
    • Slack Notifications
    • Audit Log
    • Hubs
  • Troubleshooting
    • How to troubleshoot
    • Common fixes
      • Extensions
      • Agents
      • On-prem platform
Powered by GitBook

Extension Docs

  • ActionKit
  • DiscoveryKit
  • EventKit

More Resources

  • Reliability Hub
  • API Docs
On this page

Was this helpful?

Edit on GitHub
  1. Install and Configure
  2. Install Agent

Configuration Options

There are plenty of options for the agent that can be controlled using Environment variables.

Environment Variable
Description

STEADYBIT_AGENT_KEY

The API key the agent uses Example: foobar

STEADYBIT_AGENT_REGISTER_URL

The baseUrl where the agent registers. Default: https://platform.steadybit.com

STEADYBIT_LOG_LEVEL

Sets the loglevel for the com.steadybit logger Default: INFO

LOG_LEVEL

Sets the loglevel for the root logger Default: INFO

STEADYBIT_LOG_FORMAT

Sets the log format for the console logger (json or text) Default: text

STEADYBIT_AGENT_REGISTER_TIMEOUT

Timeout for the registration request. Default: 5s

STEADYBIT_AGENT_REGISTER_INTERVAL

The interval how often the agent registers at the platform. Default: 5s

STEADYBIT_AGENT_EXPERIMENT_TIMEOUT

Timeout for the request to connect to an experiment. Default: 5s

STEADYBIT_AGENT_EXPERIMENT_KEEP_ALIVE_INTERVAL

Interval how often a keep alive is sent during an experiment. Default: 2s

STEADYBIT_AGENT_EXPERIMENT_KEEP_ALIVE_TIMEOUT

Timeout for a keep alive during an experiment Default: 10s

STEADYBIT_AGENT_WEBSOCKET_PING_INTERVAL

Interval in seconds of the heartbeat for the websocket connection Default: 4s

STEADYBIT_AGENT_EXTENSIONS_TIMEOUT_CONNECT

Connect timeout for extension communication Default: 10s

STEADYBIT_AGENT_EXTENSIONS_TIMEOUT_READ

Read timeout for extension communication Default: 30s

STEADYBIT_AGENT_EXTENSIONS_TIMEOUT_CALL

Call timeout for extension communication Default: 30s

STEADYBIT_AGENT_EXTENSIONS_AUTOREGISTRATION_NAMESPACE

Filter extension auto registration in Kubernetes to a given namespace. Default: null

SERVER_PORT

HTTP endpoint port Default: 42899

STEADYBIT_AGENT_PROXY_HOST

Hostname of a proxy to access Steadybit platform

STEADYBIT_AGENT_PROXY_PORT

Port of a proxy to access Steadybit platform

STEADYBIT_AGENT_PROXY_PROTOCOL

Protocol of a proxy to access Steadybit platform Valid values: HTTP, SOCKS4, SOCKS5 Default: http

STEADYBIT_AGENT_PROXY_USER

Username of a proxy to access Steadybit platform

STEADYBIT_AGENT_PROXY_PASSWORD

Password of a proxy to access Steadybit platform

STEADYBIT_AGENT_IDENTIFIER

The identifier which will be used to register the agent at the platform Default: The agent will use the hostname as identifier

STEADYBIT_AGENT_AUTH_PROVIDER

The auth mechanism to use - OAUTH2 or AGENT-KEY

Default: AGENT-KEY

STEADYBIT_AGENT_AUTH_OAUTH2_CLIENT_ID

The public identifier of your OAuth 2.0 Client

STEADYBIT_AGENT_AUTH_OAUTH2_CLIENT_SECRET

The client secret

STEADYBIT_AGENT_AUTH_OAUTH2_ISSUER_URI

The issuer uri of the identity provider

STEADYBIT_AGENT_AUTH_OAUTH2_TOKEN_URI

The token uri of the identity provider to directly specify the URL to retrieve the access tokens from

STEADYBIT_AGENT_AUTH_OAUTH2_AUDIENCE

Optional - Some provider needs the audience parameter to authenticate the client.

STEADYBIT_AGENT_AUTH_OAUTH2_AUTHORIZATION_GRAN_TYPE

The grant type to use either client_credentials or password. Default: client_credentials

STEADYBIT_AGENT_AUTH_OAUTH_USERNAME

The username to use for the username flow

STEADYBIT_AGENT_AUTH_OAUTH_PASSWORD

The username to use when using the password flow

STEADYBIT_AGENT_AUTH_OAUTH_CLIENT_CERT_CHAIN_FILE

Optional - the x.509 client certificate to use for mutual TLS with the identity provider.

STEADYBIT_AGENT_AUTH_OAUTH_CLIENT_CERT_KEY_FILE

Optional - the PKCS#8 encoded private key to use for mutual TLS with the identity provider

STEADYBIT_AGENT_AUTH_OAUTH_CLIENT_CERT_PASSWORD

Optional - Password for the the PKCS#8 encoded private key to use for mutual TLS with the identity provider

RESILIENCE4J.RETRY_INSTANCES_HTTPDISCOVERY_MAXATTEMPTS

Optional - Resilience4j: The maximum number of attempts (including the initial call as the first attempt) for DiscoveryKit resources

RESILIENCE4J.RETRY_INSTANCES_HTTPDISCOVERY_WAITDURATION

Optional - Resilience4j: A fixed wait duration between retry attempts for DiscoveryKit resources

RESILIENCE4J.RETRY_INSTANCES_HTTPDISCOVERY_ENABLEEXPONENTIALBACKOFF

Optional - Resilience4j: Enable or disable exponential backoff for DiscoveryKit resources

RESILIENCE4J.RETRY_INSTANCES_HTTPDISCOVERY_EXPONENTIALBACKOFFMULTIPLIER

Optional - Resilience4j: The multiplier for exponential backoff for DiscoveryKit resources

STEADYBIT_AGENT_HTTP_DISCOVERY_USE_RETRY

Optional - Resilience4j: Enable/Disable the retry mechanism. Default is true / enabled

STEADYBIT_AGENT_WEBCLIENT_USE_POOL

Optional - Be able to disable the netty connection pooling by setting environment variable STEADYBIT_AGENT_WEBCLIENT_USE_POOL=false. Default is true.

Last updated 29 days ago

Was this helpful?