3.1. Startup configuration

halon-rated loads the non-reloadable startup configuration is read from /etc/halon/rated.yaml.

Below are some of the most important settings that can be configured.

Note

The example configuration in /opt/halon/share/examples/ that is usually copied to /etc/halon/ during installation contains reasonable defaults. Normally you only need to modify the secret key to use.

3.1.1. Listener directives

listen.port: Which TCP port to listen on. The default is 13131.

listen.address: IPv4 or IPv6 address to listen on. The default is to listen to all IPv4 and IPv6 addresses.

3.1.2. Clustering directives

key

A HMAC-SHA1 key used for rate synchronization between rated instances in HEX format.

key: a3faf19660fea508afaab8648b4aa3b9f685acd0 # do not use this specific key

syncdelay: The microseconds delay between sending rate packages. This prevents network overload when doing UDP synchronization. The default is 25 microseconds. This allows 40’000 PPS.

reresolve: Automatically re-resolve the hostnames of the synchronization peers (as specific in rated-app.yaml) every x seconds (The default is to never re-resolve the hostnames of the synchronization peers automatically)

3.1.3. Environment directives

The default startup configuration that came with the installation package contains reasonable defaults for your platform. Some settings should however be revised.

3.1.3.1. Configuration paths

Those paths can normally be left unchanged.

environment.appconf: From where to load the running configuration. The default is /etc/halon/rated-app.yaml.

3.1.3.2. Other environment

Those settings should normally be left unchanged. The default startup configuration in /opt/halon/examples that came with the installation package should contain correct parameters for your operating system or distribution.

environment.socket.path: Have the API socket on a UNIX socket. This option is mutually exclusive with the environment.controlsocket.port setting. The default is /var/run/halon/rated.sock.

environment.socket.owner: This option is only supported with the environment.socket.path setting.

environment.socket.group: This option is only supported with the environment.socket.path setting.

environment.socket.chmod: This option is only supported with the environment.socket.path setting.

environment.controlsocket.port: Have the control socket on a TCP port. This option is mutually exclusive with the environment.controlsocket.path setting.

environment.controlsocket.address: Have the control socket listen on a specific IP address. This option is only supported with the environment.controlsocket.port setting.

environment.controlsocket.path: Have the control socket on a UNIX socket. This option is mutually exclusive with the environment.controlsocket.port setting. The default is /var/run/halon/rated.ctl.

environment.controlsocket.owner: This option is only supported with the environment.controlsocket.path setting.

environment.controlsocket.group: This option is only supported with the environment.controlsocket.path setting.

environment.controlsocket.chmod: This option is only supported with the environment.controlsocket.path setting.

environment.controlsocket.port: Have the control socket on a TCP port. This option is mutually exclusive with the environment.controlsocket.path setting.

environment.controlsocket.address: Have the control socket listen on a specific IP address. This option is only supported with the environment.controlsocket.port setting.

environment.privdrop.user: The user to run the process as.

environment.privdrop.group: The group to run the process as.