Configuration

You can configure tibrvmon from the following sources, by precedence:

  • Command line

  • Environment variables

  • Configuration file (YAML)

When you define a parameter in multiple configuration sources, the application uses the value defined in the highest priority source.

You can define all parameters in the configuration file, except the path of the configuration file, whether it relates to clients connecting to tibrvmon or tibrvmon connecting to Rendezvous daemons. Use the command-line configuration or environment variable to add the path of the configuration file.

Parameters

loglevel

This parameter sets the severity level of the logging output. Log statements at the level specified by you or above are generated and stored. For example, if you set loglevel as warn, the log entries of level warn or above are generated and saved. Valid values in descending order of severity are:

  • disabled

  • trace

  • debug

  • info

  • warn

  • error

  • fatal

  • panic

The default value is info.

Configuration File Usage

Copy 
loglevel: debug

Command-Line Usage

Copy 
--log-level debug

monitor

The parameters mentioned in this section apply to the connections between tibrvmon and its clients.

monitor.disableTLS

This parameter disables TLS between clients connecting to tibrvmon. The default value is false.

Configuration File Usage

Copy 
monitor:
  disableTLS: true

Command-Line Usage

Copy 
--disable-tls

monitor.listener

This parameter lists the [ip]:[port] address to which tibrvmon listens. The default value is 7585.

Configuration File Usage

Copy 
monitor:
  listener: 127.0.0.1:8950

Command-Line Usage

Copy 
--listen 127.0.0.1:8950

monitor.cert

This parameter is used to specify the TLS server certificate to use for the monitor.listener parameter. A random self-signed certificate is generated when TLS is not disabled or the monitor.cert parameter is empty.

Configuration File Usage

Copy 
monitor:
  cert: mycert.pem

Command-Line Usage

Copy 
--cert mycert.pem

Environment Variable

Copy 
TIBRVMON_MONITOR_CERT=mycert.pem

monitor.key

This parameter is used to specify the private key associated with the certificate.

Configuration File Usage

Copy 
monitor:
  key: mykey.pem

Command-Line Usage

Copy 
--key mykey.pem

Environment Variable

Copy 
TIBRVMON_MONITOR_KEY=mykey.pem

monitor.keypassword

This parameter is used to enter the password to decrypt password if the private key is encrypted.

Configuration File Usage

Copy 
monitor:
  keypassword: pkeypass.txt

Environment Variable

Copy 
TIBRVMON_MONITOR_KEYPASSWORD=pkeypass.txt

monitor.requireClientCert

This parameter requires clients connecting to tibrvmon to present a valid and trusted client certificate. The default value is false.

Configuration File Usage

Copy 
monitor:
  requireClientCert: true

Command-Line Usage

Copy 
--require-client-cert

monitor.clientCerts

This parameter specifies the list of paths to files containing the public certificates of certificate authorities or individual clients that the monitor trusts. It is a required parameter if the requireClientCert parameter is set to true.

Configuration File Usage

Copy 
monitor:
  clientCerts: []

rv

The parameters mentioned in this section apply to the connections between tibrvmon and the discovered Rendezvous daemons.

rv.skipVerify

This parameter skips certificate verification of a Rendezvous HTTPS server. The default value is false.

Configuration File Usage

Copy 
rv:
  skipVerify: true

Command-Line Usage

Copy 
--skip-verify

rv.serverCerts

This parameter is used to add the server certificates to the tibrvmon certificate pool. When connecting to a Rendezvous HTTPS server, tibrvmon tries each of these certificates and the system pool. This option is ignored if the skipVerify parameter is set to true.

Configuration File Usage

Copy 
rv:
  serverCerts:
    - cert1.pem
    - cert2.pem

rv.pollInterval

This parameter is used to enter the rate (in seconds) at which tibrvmon polls the status of all the discovered daemons. When tibrvmon receives a request to retrieve the status of the daemons, it uses the cached value from the most recent successful poll. The default value is 5 seconds.

Configuration File Usage

Copy 
rv:
  pollInterval: 5

Command-Line Usage

Copy 
--poll-interval 10

rv.transports

This parameter is used to enter the list of Rendezvous transports for tibrvmon to create.

Configuration File Usage

Copy 
rv:
  transports:
  - service: "20000"
    network: ";239.255.0.1"
    daemon: "7500"
  - service: "20001"
    network: ";239.255.0.1"
    daemon: "7500"

config

This parameter is used to specify path to the configuration file.

Command-Line Usage

Copy 
--config tibrvmon.yaml

Environment Variable

Copy 
TIBRVMON_CONFIG=tibrvmon.yaml

no-color

This parameter disables the color of the logger output.

Command-Line Usage

Copy 
--no-color

help

This parameter prints all the command-line options.

Command-Line Usage

Copy 
--help