Tags:
Categories:

Aura Redis Mongo Synchronizer environment variables

Notation

List of environment variables defined for aura-redis-mongo-sync component

  • Properties marked in bold are mandatory.
  • Properties marked in italics are optional.
Property Type Description Modifiable by OB?
AURA_LOGGING_EXTRA_TIME_METRICS Boolean Extra time metrics for logging. By default: false. No
AURA_LOGGING_LEVEL String Level to be used in monitoring logs, from more to less verbose: 'TRACE', 'DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL', 'OFF'. By default: INFO. Yes
AURA_MONGODB_BOT_COLLECTION_CACHES_INDEX_TTL Number Lifetime, in seconds, for the index of the caches collection. By default: 3600 No. Only if validated with Aura Global team, because it is related to other values.
AURA_MONGODB_BOT_COLLECTION_CONTEXT String Name of the collection where the context is stored. By default: aura-context. No
AURA_MONGODB_BOT_DATABASE String Name of the database where the bot collections are stored. By default: aura-bot No
AURA_MONGODB_PASSWORD String Password of the user that accesses MongoDB. No. Only if MongoDB credentials must be changed.
AURA_MONGODB_POOL_SIZE Number Pool size of the MongoDB. By default: 60. No.
AURA_MONGODB_SSL Boolean Flag to indicate if MongoDB connection uses SSL or not. By default: true. No
AURA_MONGODB_URI String URI of the MongoDB No
AURA_MONGODB_USERNAME String Username of the MongoDB No
AURA_REDIS_CONFIGURATION_PREFIX String Prefix for Redis configuration keys. By default: aura-config: No
AURA_REDIS_CONTEXT_CACHE_PREFIX String Prefix for Redis context cache keys. By default: context: No
AURA_REDIS_SUBSCRIPTIONS_EVENTS String Comma-separated list of the types of Redis messages to trigger subscriptions events. By default: expired,evicted No
AURA_REDIS_CONTEXT_CACHE_SHADOW_KEY_PREFIX String Prefix for Redis shadow key cache keys. By default: shadow-key: No
AURA_REDIS_CONTEXT_CACHE_ACTIVE_CONTEXT_PREFIX String Prefix for Redis active context cache keys. By default: active-context: No
AURA_REDIS_CONTEXT_CACHE_LOCK_PREFIX String Prefix for Redis lock context cache keys. By default: lock-context: No
AURA_REDIS_CONTEXT_CACHE_MIN_SHARD_BY_NODE Number Number of minimal shards assigned to a service. By default: 1 No
AURA_REDIS_CONTEXT_CACHE_CHECK_INDEX_SHARD_INTERVAL Number Number of seconds to wait before recalculate shards to subscribe events. By default: 60. No
AURA_REDIS_CONTEXT_CACHE_CHECK_UNPROCESSED_INTERVAL_MIN Number Minimum number of seconds to wait before checking unprocessed contexts. By default: 10. No
AURA_REDIS_CONTEXT_CACHE_CHECK_UNPROCESSED_INTERVAL_MAX Number Maximum number of seconds to wait before checking unprocessed contexts. By default: 120. No
AURA_REDIS_CONTEXT_CACHE_CHECK_UNPROCESSED_FACTOR Number Factor to increment or decrement interval to check unprocessed contexts. By default: 1.1. No
AURA_REDIS_CONTEXT_CACHE_UNPROCESSED_RANGE Number Number of unprocessed contexts to check by turn. By default: 10. No
AURA_REDIS_CONTEXT_CACHE_UNPROCESSED_RANGE_FACTOR Number Factor to divide the unprocessed range. By default: 5. No
AURA_REDIS_CONTEXT_CACHE_SHARD_COUNT Number Number of shards to generate lists for storing unprocessed context. For performance reasons, it is important to configure the same number as the number of pods of the aura-redis-mongo-synchronizer. No
AURA_REDIS_CONTEXT_CACHE_TTL Number Time in seconds to store a context in cache. By default: 60. No
AURA_REDIS_LOCK_CONTEXT_CACHE_TTL Number Time in seconds to store a lock context in cache. By default: 60. No
AURA_REDIS_MODE String Mode of Redis distribution. Values: Cluster, Sentinel or Single. By default: Single. No
AURA_REDIS_PREFIX String Prefix that will be used by all Redis keys when using redis-connector. This allows mixing in a single Redis service messages coming from different environments in the same Azure subscription. No
AURA_REDIS_SENTINEL_INSTANCE_NAME String Name of the Redis instance. Used in Sentinel mode. No
AURA_REDIS_HOSTS String A string with a list of nodes (host:port) separated by comma. For example: “localhost:port,localhost2:port2”. Default: ‘127.0.0.0:6379’ No
AURA_REDIS_DATABASE Number Database number for Single or Sentinel mode. By default: 0.
AURA_REDIS_PASSWORD String A string with the password of Redis. No
AURA_REDIS_MAX_RECONNECT_RETRIES Number Number of retries to connect to Redis. By default: 25. No
AURA_REDIS_MAX_RECONNECT_INTERVAL Number Time in milliseconds to wait before reconnecting to Redis. By default: 5000. No
AURA_REDIS_USE_CONNECTION_POOL Boolean Flag to indicate to use a connection pool for Redis connections. Default: true. No
AURA_REDIS_CONNECTION_POOL_MIN Number Minimum number of connections in the pool. Default: 2. No
AURA_REDIS_CONNECTION_POOL_MAX Number Maximum number of connections in the pool. Default: 100. No
AURA_REQUEST_TIMEOUT Number Number of seconds to wait a request. By default: 30 * 1000. No
AURA_SERVER_PORT Number Port where the server will be listening. By default: 8989 No
AURA_SERVER_RETRIES Number Number of retries made by the server in case of error in an HTTP request. By default: 3. No
AURA_SERVER_RETRY_DELAY Number Delay between retries in case of error. By default: 100. No
AURA_SERVER_RETRY_FACTOR Number Factor to multiply delay for every HTTP request retried. By default: 10. No
AURA_SERVICE_ENVIRONMENT Number 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 p process all the messages in queue before SIGTERM. By default: 25 * 1000 No
AURA_VERSION String Aura version. It is set by the deployment process. No
Last modified March 21, 2025: fix: Nodoubt - Fixes and adjustments master (#2088) (4a4eb446)