Environments
The tables below contain all of the environment variables used to configure each microservice container. Default values are defined where applicable as well as descriptions for each.
Shared
The following envrionment variables are shared across all microservice images:
| Name | Type | Default | Description |
|---|---|---|---|
| NODE_ENV | String | 'production' | microservice runtime environment |
| PORT | Number | 3000 | microservice port to listen on |
| HTTP_VERSION | Number | 2 | HTTP version for backward compatibility |
| SECURE | String | 'false' | whether to run microservice secure or not. defaults to 'false' since we cannot provide certificates |
| CLUSTER_SIZE | Number | [total CPUs available] | defaults to the total available CPUs allocated to the container or to the size you specify here |
| SSL_CERT | String | default path for SSL certificate file or the full certificate | |
| SSL_KEY | String | default path for SSL key file or the full key | |
| PING_URL | String | '/ping' | URL to use for shallow health checks for the microservice |
| ACTOR | String | Actor (Model) the microservice is responsible for | |
| ACTOR_LIB | String | module where the ACTOR resides | |
| ACTOR_URLS | String | comma-separated URLs associated with the Actor | |
| TELEMETRY | String | 'false' | whether to run OpenTelemetry integration |
| TELEMETRY_PLUGINS | String | JSON string of OpenTelemetry plugins to enable | |
| TELEMETRY_SERVICE_NAME | String | service name for OpenTelemetry | |
| TELEMETRY_URL_METRICS | String | OpenTelemetry Collector URL for metrics | |
| TELEMETRY_URL_TRACES | String | OpenTelemetry Collector URL for traces |
Base
All of the environment variables in Shared.
Producer
All of the environment variables in Shared and the following:
| Name | Type | Default | Description |
|---|---|---|---|
| EVENT_STORE_TOPIC | String | Kafka topic the events will be stored under | |
| EVENT_STORE_ID | String | unique identifier for Kafka client connection | |
| EVENT_STORE_BROKERS | String | comma separated URLs where Kafka is hosted | |
| EVENT_STORE_BUFFER | Number | 100 | maximum number of incoming messages to batch |
| EVENT_STORE_TIMEOUT | Number | 2000 | time (in `ms`) to poll Kafka for delivery reports |
Consumer
All of the environment variables in Shared and the following:
| Name | Type | Default | Description |
|---|---|---|---|
| EVENT_STORE_TOPIC | String | Kafka topic the events will be consumed from | |
| EVENT_STORE_ID | String | unique identifier for Kafka client connection | |
| EVENT_STORE_GROUP_ID | String | defines Kafka Consumer group id | |
| EVENT_STORE_BROKERS | String | comma separated URLs where Kafka is hosted | |
| EVENT_STORE_FROM_START | String | 'false' | tells Consumer whether or not to start at the beginning of the topic |
| EVENT_STORE_PARTITIONS | Number | 1 | tells Consumer how many partitions to consume |
| EVENT_STORE_BUFFER | Number | null | maximum number of incoming messages to batch |
| EVENT_STORE_TIMEOUT | Number | null | time (in `ms`) to poll Kafka for delivery reports |
Stream Processor
All of the environment variables in Shared and the following:
| Name | Type | Default | Description |
|---|---|---|---|
| PROCESSOR_TYPE | String | 'producer' | type of Stream Processor microservice you wish to run (can also be 'consumer' or 'stream_processor') |
| EVENT_STORE_PRODUCER_TOPIC | String | Kafka topic the events will be stored under | |
| EVENT_STORE_CONSUMER_TOPIC | String | Kafka topic the events will be consumed from | |
| EVENT_STORE_ID | String | unique identifier for Kafka client connection | |
| EVENT_STORE_GROUP_ID | String | defines Kafka Consumer group id | |
| EVENT_STORE_BROKERS | String | comma separated URLs where Kafka is hosted | |
| EVENT_STORE_FROM_START | String | 'false' | tells Consumer whether or not to start at the beginning of the topic |
| EVENT_STORE_PARTITIONS | Number | 1 | tells Consumer how many partitions to consume |
| EVENT_STORE_BUFFER | Number | 100 | maximum number of incoming messages to batch |
| EVENT_STORE_TIMEOUT | Number | 2000 | time (in `ms`) to poll Kafka for delivery reports |
| CACHE_URL | String | URL where Redis is hosted | |
| LOCK_TTL | Number | 2000 | Redlock time to live before lock is released |
| LOCK_DRIFT_FACTOR | Number | 0.01 | Redlock drift factor setting |
| LOCK_RETRY_COUNT | Number | 0 | Redlock retry count setting, should be set to zero for concurrency |
| LOCK_RETRY_DELAY | Number | 400 | Redlock retry delay in milliseconds |
| LOCK_RETRY_JITTER | Number | 400 | Redlock random retry jitter in milliseconds to randomize retries |