Machine-readable metrics

Automation Config

metrics configuration

# System metrics settings
metrics:
  enabled: true                         # If True, enable the collection of system metrics
  prometheus: false                     # If True, enable the Prometheus endpoint at /metrics
  prometheus_username:                  # Static username for retrieving /metrics
  prometheus_password:                  # Static password for retrieving /metrics
  snapshot_interval: 60                 # How often to record snapshot metrics, in seconds
  max_query_timedelta: 86400            # Maximum timedelta for a single call to get_system_metrics, in seconds
  keep: 30                              # How long to retain metrics data, in days

To disable metrics collection, set
enabled:false
. Note that this will also disable the
Automation Config
built-in dashboard.
To enable the export of machine-readable metrics from the
/metrics
http endpoint, set
prometheus:true
. This setting does not affect the
Automation Config
built-in dashboard.
To access the
/metrics
http endpoint by http Basic Authentication, set your credentials in plaintext using the
prometheus_username
and
prometheus_password
variables. To authenticate using encrypted credentials or environmental variables, leave these variables blank. See #GUID-AA83E276-5BD7-44FA-9094-F00F3A94D0C8_SECTION_2443DC87-85FC-4394-8D1B-283CF18EB6DE-en for more information about authentication methods.

Salt Master metrics configuration

Metrics on Salt events and job returns will be accurate only if the
sseapi
returner is configured on the Salt masters.
Automation Config
will collect low-level function runtime information from Salt masters that have
master_stats:true
set in their configuration. This option is disabled by default. See master_stats in the Salt documentation for details.

Metrics on salt job states will be accurate only if the job completion engine is enabled in the Salt Master Plugin:
engines:
   - jobcompletion: {}
This engine is enabled in the Salt Master Plugin default configuration.

Configuring Prometheus to connect to

Automation Config

To store your credentials in an encrypted bundle on
etc/raas/raas.secconf
, run
raas save_creds
from the command-line interface (CLI). The CLI then prompts you for your Postgres, Redis, and Prometheus credentials. You can also pass your credentials through the CLI using this syntax, replacing the example text with your credentials:
raas save_creds 'postgres={"username": "root", "password": "salt"} redis={"username": "default", "password": "redis123"} prometheus={"username": "metrics", "password": "prometheus"}'
. See Securing credentials in your SaltStack Enterprise configuration for more information.
To store your credentials in environmental variables for use with container images, use the variables
PROMETHEUS_USERNAME
and
PROMETHEUS_PASSWORD
.
To store your credentials in plaintext, set the
prometheus_username
and
prometheus_password
variables in the
/etc/raas/raas
configuration file, as noted in the section above. These credentials are stored only in the
/etc/raas/raas
configuration file, are not associated with any
Automation Config
account, and cannot be used to authenticate to
Automation Config
other than for accessing the
/metrics
http endpoint.

scrape_configs:
  - job_name: 'sse'

    metrics_path: '/metrics'
    scheme: 'http'

    static_configs:
        - targets: ['localhost:8080']

    basic_auth:
      username: prometheus
      password: metrics

Metric descriptions