Eventhistory Service Configuration
Introduction
The Infinite Scale eventhistory service consumes all events from the configured event system like NATS, stores them and allows other services to retrieve them via an event ID.
Storing
The eventhistory
service stores each consumed event via the configured store in EVENTHISTORY_STORE_TYPE
. Possible stores are:
Store Type | Description |
---|---|
|
Basic in-memory store and the default. |
|
Advanced in-memory store allowing max size. |
|
Stores data in a configured Redis cluster. |
|
Stores data in a configured etcd cluster. |
|
Stores data using the key-value-store feature of NATS JetStream. |
|
Stores nothing. Useful for testing. Not recommended in productive environments. |
-
Note that in-memory stores are by nature not reboot persistent.
-
Though usually not necessary, a database name and a database table can be configured for event stores if the event store supports this. Generally, this does not apply to stores of type
in-memory
. These settings are blank by default which means that the standard settings of the configured store applies. -
Events stay in the store for 2 weeks by default. Use
EVENTHISTORY_RECORD_EXPIRY
to adjust this value. -
The
eventhistory
service can be scaled if it’s not usingin-memory
stores and the stores are configured identically over all instances.
Retrieving
Other services can call the eventhistory
service via a gRPC call to retrieve events. The request must contain the event ID that should be retrieved.
Configuration
Environment Variables
The eventhistory
service is configured via the following environment variables:
Name | Type | Default Value | Description |
---|---|---|---|
|
string |
|
The log level. Valid values are: "panic", "fatal", "error", "warn", "info", "debug", "trace". |
|
bool |
false |
Activates pretty log output. |
|
bool |
false |
Activates colorized log output. |
|
string |
|
The path to the log file. Activates logging to this file if set. |
|
string |
|
Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed. |
|
string |
|
Token to secure the metrics endpoint. |
|
bool |
false |
Enables pprof, which can be used for profiling. |
|
bool |
false |
Enables zpages, which can be used for collecting and viewing in-memory traces. |
|
string |
127.0.0.1:0 |
The bind address of the GRPC service. |
|
string |
127.0.0.1:9233 |
The address of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. |
|
string |
ocis-cluster |
The clusterID of the event system. The event system is the message queuing service. It is used as message broker for the microservice architecture. Mandatory when using NATS as event system. |
|
bool |
false |
Whether to verify the server TLS certificates. |
|
string |
|
The root CA certificate used to validate the server’s TLS certificate. If provided NOTIFICATIONS_EVENTS_TLS_INSECURE will be seen as false. |
|
bool |
false |
Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services.. |
|
string |
memory |
The type of the eventhistory store. Supported values are: 'memory', 'ocmem', 'etcd', 'redis', 'redis-sentinel', 'nats-js', 'noop'. See the text description for details. |
|
[]string |
[] |
A comma separated list of nodes to access the configured store. This has no effect when 'in-memory' stores are configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. |
|
string |
eventhistory |
The database name the configured store should use. |
|
string |
events |
The database table the store should use. |
|
Duration |
336h0m0s |
Time to live for events in the store. The duration can be set as number followed by a unit identifier like s, m or h. Defaults to '336h' (2 weeks). |
|
int |
0 |
The maximum quantity of items in the store. Only applies when store type 'ocmem' is configured. Defaults to 512. |
YAML Example
Note that the filename shown below has been chosen on purpose.
See the Configuration File Naming for details when setting up your own configuration.
# Autogenerated
# Filename: eventhistory-config-example.yaml
log:
level: ""
pretty: false
color: false
file: ""
debug:
addr: ""
token: ""
pprof: false
zpages: false
grpc:
addr: 127.0.0.1:0
tls: null
grpc_client_tls: null
events:
endpoint: 127.0.0.1:9233
cluster: ocis-cluster
tls_insecure: false
tls_root_ca_certificate: ""
enable_tls: false
store:
store: memory
nodes: []
database: eventhistory
table: events
record_expiry: 336h0m0s
size: 0