Tags:
Categories:

Agents Manager environment variables

List of environment variables handled by agents-manager

  • Properties marked in bold are mandatory.
  • Properties marked in italics are optional.

Introduction

agents-manager environment variables can be common for all plugins or specific for each of them.

Common properties

Property Type Description Modifiable by OB?
AURA_AUTHORIZATION_HEADER string APIKey to use with aura-services. NO
AURA_DEFAULT_LOCALE string Culture code to be used by default in the current deployment: de-de, en-gb, es-es, pt-br. NO
AURA_DEFAULT_TIME_ZONE string Timezone where the service is running. NO
AURA_ENCRYPTION_ALGORITHM string Encryption algorithm that will be used to validate the APIKey. By default: aes-256-cbc. NO
AURA_ENCRYPTION_IV_LENGTH number Size for the initialization vector used by the encryption algorithm that validates the APIKey. By default: 16. NO
AURA_ENCRYPTION_IV_POSITION number Position where to insert the initialization vector in the final string with the encrypted payload. By default: 35. NO
AURA_ENCRYPTION_KEY string Encryption key or comma-separated list of encryption keys to be used in the environment. It is mainly used to decrypt the APIKeys. NO. It would break database encrypted data and APIKey validation.
AURA_ENVIRONMENT_NAME string Name of the environment where the server is deployed. Used during server make-up to handle the indexes of the database properly. NO
AURA_ENVIRONMENT_PREFIX string Prefix that will be used by all Redis keys when using redis-connector. By default: ``. (empty) YES
AURA_HTTP_KEEP_ALIVE boolean Use of keep-alive in HTTP connections. Used in monkey-patcher. By default: true. NO
AURA_HTTP_KEEP_ALIVE_MSECS number Number of milliseconds to keep alive HTTP connections. Used in monkey-patcher. By default: 100000. NO
AURA_HTTP_KEEP_MAX_SOCKETS number Maximum number of sockets. Used in monkey-patcher. By default: 250. NO
AURA_HTTP_MAX_REQUEST_SIZE string Maximum size in bytes of body request. Allowed values must indicate the units: 10 mb, 200 kb, etc. By default, 20mb. NO
AURA_LOGGING_FORMAT string Format to be used in monitoring logs: json or dev(more visual format). By default: json. NO. Only for development, set it to dev.
AURA_LOGGING_LEVEL string Level to be used in logs, from more to less verbose: 'TRACE', 'DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL', 'OFF'. By default: INFO. NO
AURA_MAKEUP_MODE string It allows dev mode for the make-up process with the value local. By default: full. NO
AURA_MICROSOFT_AZURE_STORAGE_ACCESS_KEY string Microsoft Storage password of the deployment. NO
AURA_MICROSOFT_AZURE_STORAGE_ACCOUNT string Microsoft Storage account of the environment. NO
AURA_MICROSOFT_AZURE_STORAGE_CONFIGURATION_CONTAINER string Aura configuration container name. By default: aura-configuration. NO
AURA_HTTP_MONKEY_PATCHER_ENABLED boolean Flag to indicate whether Monkey Patcher is used in service or not. NO
AURA_SERVER_PORT number Port to where server is listening. By default: 8990. NO
AURA_SERVER_REMOTE_CONTAINER_PREFIX number Remote container prefix. By default: agents-manager. NO
AURA_SERVICE_ENVIRONMENT string Type of environment: 'DEV', 'PRE', 'PRO'. By default, DEV. It is used during locale translation, to get the correct text reference. NO
AURA_SHUTDOWN_GRACEFUL_TTL number Time in milliseconds to complete the SHUTDOWN signal and process all the messages in queue before SIGTERM. By default: 25 * 1000. NO
AURA_SWAGGER_FROM_REMOTE boolean Flag to indicate whether the swagger file is loaded from remote or not. By default: true. NO
AURA_SWAGGER_LOCAL_PATH string Location of the swagger file generated from all loaded plugins. By default: swagger.yaml. Used during makeup to upload the file to remote. NO
AURA_SWAGGER_PLUGIN_PATH string Location of the swagger file of every plugin. By default: swagger.yaml. NO
AURA_SWAGGER_LOCAL_CORE_PATH string Location of server swagger base file. By default: swagger-core.yaml. NO
AURA_SWAGGER_REMOTE_CONTAINER_PREFIX string Remote container prefix to store the swagger information. By default: swagger NO
AURA_VERSION string Mandatory, release of Aura. NO
AURA_HTTP_PATHS_LOG_DISABLED string HTTP paths separated by commas whose request would not be logged. By default aura-configuration', 'metrics', 'healthz Used in monkey-patcher. NO

development-api plugin

Property Type Description Modifiable by OB?
DEV_AURA_BEHAVIOR_PREFIX string Used in cache key prefix and in command name. By default: gateway. NO in production environments. This feature could only be activated in development environments.
DEV_AURA_BEHAVIOR_CACHE_TTL number Maximum lifetime of behavior cache in seconds. After this time, the system will delete the message. By default: 60 * 60 (60 min). NO in production environments. This feature could only be activated in development environments.
DEV_AURA_BEHAVIOR_COMMAND_PATTERN string Pattern to recognize a behavior command. By default: gateway(:| +)(get|set|unset)(:| +)(\w+)(:| +)?.+ NO in production environments. This feature could only be activated in development environments.

configuration-service plugin

Property Type Description Modifiable by OB?
AURA_CONFIGURATION_API_ENDPOINT string Configuration API URL where the server should get the configuration. NO
AURA_AUTHORIZATION_HEADER string APIKey to use with aura-services. NO
AURA_CONFIGURATION_RETRIES number Number of retries to get the configuration. By default: 3. NO, only if checked and validated with Aura Global Team.
AURA_CONFIGURATION_RETRY_DELAY number Delay between retries in case of error. By default: 100. NO, only if checked and validated with Aura Global Team.
AURA_CONFIGURATION_RETRY_FACTOR number Factor to multiply delay for every HTTP request retried. By default: 10. NO, only if checked and validated with Aura Global Team.

redis-connector-service plugin

Property Type Description Modifiable by OB?
AURA_REDIS_MODE string Mode of Redis distribution. Values: CLUSTER, SENTINEL, SINGLE. By default: SENTINEL. NO
AURA_REDIS_SENTINEL_INSTANCE_NAME string Name of the Redis instance. Used in SENTINEL mode. NO
AURA_REDIS_HOSTS string String with a list of nodes separated by ‘,’, including host and port separated by ‘:’. For example: “localhost:port,localhost2:port2”. NO
AURA_REDIS_DATABASE number Database number for SINGLE or SENTINEL mode. By default: 0. YES
AURA_REDIS_PASSWORD string String with Redis password. YES
AURA_REDIS_USE_CONNECTION_POOL boolean Use pool connections for Redis. By default: true. YES
AURA_REDIS_CONNECTION_POOL_MIN number Minimum number of connections in the pool. By default: 2. YES
AURA_REDIS_CONNECTION_POOL_MAX number Maximum number of connections in the pool. By default: 100. YES
AURA_REDIS_MAX_RECONNECT_RETRIES number Number of retries to connect to Redis. By default: 25 YES
AURA_REDIS_MAX_RECONNECT_INTERVAL number Time in milliseconds to wait before reconnecting to Redis. By default: 5000. YES

session-service plugin

Property Type Description Modifiable by OB?
AURA_SESSION_MAX_HISTORY_LENGTH number Maximum number of messages to keep in history. Default: 10. NO
AURA_SESSION_EXPIRE_TIME number Expire time for the conversation history in seconds. Default: 3600 (1 hour). NO
Last modified September 4, 2025: feat: Next steps for agents platform. #AURA-29924 [RTM] (60eae014)