Configuration

The salt-exporter can be configured with flags, environments variables and configuration file.

Info

The precedence order for the different methods is:

• flags
• environment variables
• configuration file (config.yml)

Configuration file

The exporter is looking for config.yml.

Note: You can specify a specific config filepath using --config-file, i.e. --config-file="/srv/salt-exporter/config.yml"

See below a full example of a configuration file:

log-level: "info"

listen-address: ""
listen-port: 2112

pki-dir: /etc/salt/pki/master
ipc-file: /var/run/salt/master/master_event_pub.ipc

tls:
  enabled: true
  key: "/path/to/key"
  certificate: "/path/to/certificate"

metrics:
  global:
    filters:
      ignore-test: false
      ignore-mock: false

  salt_new_job_total:
    enabled: true

  salt_expected_responses_total:
    enabled: true

  salt_function_responses_total:
    enabled: true
    add-minion-label: false  # not recommended in production

  salt_scheduled_job_return_total:
    enabled: true
    add-minion-label: false  # not recommended in production

  salt_responses_total:
    enabled: true

  salt_function_status:
    enabled: true
    filters:
      functions:
        - "state.highstate"
      states:
        - "highstate"

Global parameters

Parameter	Default	Description
log-level	info	log level can be: debug, info, warn, error, fatal, panic, disabled
listen-address	0.0.0.0	listening address
listen-port	2112	listening port
pki-dir	/etc/salt/pki/master	path to Salt master's PKI directory

TLS settings

All parameters below are in the tls section of the configuration.

Parameter	Default	Description
enabled	false	enables/disables TLS on the metrics webserver
key		TLS key for the metrics webserver
certificate		TLS certificate for the metrics webserver

Metrics global settings

All parameters below are in the metrics.global section of the configuration.

Parameter	Default	Description
filters.ignore-test	false	ignores test=True events
filters.ignore-mock	false	ignores mock=True events

Metrics configuration

All parameters below are in the metrics section of the configuration.

Parameter	Default	Description
<metrics_name>.enabled	true	enables or disables a metric
<metrics_name>.add-minion-label Only for: salt_function_responses_total salt_scheduled_job_return_total	false	adds minion label not recommended can lead to cardinality issues
salt_function_status.filters.function	state.highstate	updates the metric only if the event function matches the filter
salt_function_status.filters.states	highstate	updates the metric only if the event state matches the filter

Minions health detection

In most of the cases all that you need to configure is to enable status beacon on Salt minions. However, if you change the pki directory for Salt master, you'll need to make a change in the exporter side too by changing it in the configuration

log-level: "info"

pki-dir: /path/as/set/in/master/config

tls:
...

Alternative methods

Environment variables

All settings available in the configuration file can be set as environment variables, but:

• all variables must be prefixed by SALT_
• uppercase only
• - in the configuration file becomes a _
• __ is the level separator

For example, the equivalent of this config file:

log-level: "info"
tls:
  enabled: true
metrics:
  global:
    filters:
      ignore-test: true

is:

SALT_LOG_LEVEL="info"
SALT_TLS__ENABLED=true
SALT_METRICS__GLOBAL__FILTERS__IGNORE_TEST=true

Flags

./salt-exporter -help
  -config-file string
        config filepath (default "config.yml")
  -health-functions-filter string
        [DEPRECATED] apply filter on functions to monitor, separated by a comma (default "highstate")
  -health-minions
        [DEPRECATED] enable minion metrics (default true)
  -health-states-filter string
        [DEPRECATED] apply filter on states to monitor, separated by a comma (default "highstate")
  -host string
        listen address
  -ignore-mock
        ignore mock=True events
  -ignore-test
        ignore test=True events
  -ipc-file string
        file location of the salt-master event bus (default "/var/run/salt/master/master_event_pub.ipc")
  -log-level string
        log level (debug, info, warn, error, fatal, panic, disabled) (default "info")
  -port int
        listen port (default 2112)
  -tls
        enable TLS
  -tls-cert string
        TLS certificated
  -tls-key string
        TLS private key
  -version
        print version