HStreamDB configuration file is located at path /etc/hstream/config.yaml in the docker image from v0.6.3. or you can download(opens new window) the config file
The identifier of a single HServer node, the value must be given and can be overwritten by cli option --server-id
address
Server listen address value, the value must be given and shouldn't be "0.0.0.0", if you intend to start a cluster or trying to connect to the server from a different network. This value can be overwritten by cli option --address
port
Server port value, the value must be given and can be overwritten by cli option --port
internal-port
Server port value for internal communications between server nodes, the value must be given and can be overwritten by cli option --internal-port
zkuri
The server nodes in the same cluster shares a zookeeper server, this is essential for a server to start Comma separated host:port pairs, each corresponding to a zk zookeeper server. e.g. 127.0.0.1:2181,127.0.0.1:2182,127.0.0.1:2183 the value must be given and can be overwritten by cli option --zkuri
log-with-color
true
optional, The options used to control whether print logs with color by the server node, can be overwritten by cli option --log-with-color
log-level
info
optional, the setting control lof print level by the server node the default value can be overwritten by cli option --log-level
max-record-size
1024*1024 (1MB)
The largest size of a record batch allowed by HStreamDB
compression
"lz4"
The option which compression should the server use when writing record to store,which can be one of "none", "lz4", "lz4hc" or "zstd:1" (the next number "1" is for zstd_level, you can also choose other level)
enable-tls
false
TLS options: Enable tls, which requires tls-key-path and tls-cert-path options
tls-key-path
TLS options: Key file path for tls, can be generated by openssl
tls-cert-path
The signed certificate by CA for the key(tls-key-path)
For the ease of use, we allow user to pass some options to override the configuration in the configuration file when start server with hstream-server :
option
meta var
description
config-path
PATH
hstream config path
host
HOST
server host value
port
INT
server port value
address
ADDRESS
server address
internal-port
INT
server channel port value for internal communication
server-id
UINT32
ID of the hstream server node
store-admin-port
INT
store admin port value
zkuri
STR
comma separated host:port pairs, each corresponding to a zk zookeeper server. e.g."127.0.0.1:2181,127.0.0.1:2182,127.0.0.1:2183"
