Prometheus Grok Exporter

Learn about configurations >

• enable-autodiscovery | boolean

  Default: True

  By default, grok exporter will automatically expose the metrics defined in files/metrics-mapping.yaml if the log files they are referred exist on the unit. To prevent this mechanism, set this option to false.

• fail-on-missing-logfile | boolean

  Default: True

  Grok exporter will not start if the log files to monitor don't exist if this is set to true.

• global-paths | string

  Comma separated list of files to monitor. All metrics not specifying an individual path are applied to all log files defined by this option.

• grok-patterns-path | string

  Default: /var/snap/prometheus-grok-exporter/current/logstash-patterns-core/patterns

  Directory with the pre-defined grok patterns. By default the charm will use the grok patterns shipped by the snap from https://github.com/logstash-plugins/logstash-patterns-core

• listen-address | string

  Default: 0.0.0.0

  The address grok-exporter will listen on to expose the metrics.

• metrics | string

  YAML formatted list of metric definitions, specifying how log lines are mapped to Prometheus metrics. For documentation refer to https://github.com/fstab/grok_exporter/blob/master/CONFIG.md#metrics-section Example of valid confinguration: metrics:

  • type: counter name: syslog_msgs_total help: Total number of syslog msgs, by program (ie daemon) match: '%{SYSLOGBASE}' labels: program: '{{.program}}'
  • type: counter name: syslog_msgs_errors_total help: Total number of syslog msgs with errors, by program (ie daemon) match: '%{SYSLOGBASE}.*[Ee]rrors?(?!${WORD})' labels: program: '{{.program}}'

• nagios_context | string

  Default: juju

  A string that will be prepended to instance name to set the host name in nagios. So for instance the hostname would be something like: juju-myservice-0 If you're running multiple environments with the same services in them this allows you to differentiate between them.

• nagios_servicegroups | string

  Default: juju

  Comma separated list of nagios servicegroups for the graphite check.

• port | int

  Default: 9144

  The port grok-exporter will listen on to expose the metrics.

• promreg_authtoken | string

  The Prometheus Registration authtoken.

• promreg_url | string

  The http(s) url and port where the Prometheus Registration service is listening.

• snap-channel | string

  Default: stable

  Controls the snap channel name. Supported values are: "stable", "candidate", "beta" and "edge"

• snapd_refresh | string

  How often snapd handles updates for installed snaps. The default (an empty string) is 4x per day. Set to "max" to check once per month based on the charm deployment date. You may also set a custom string as described in the 'refresh.timer' section here: https://forum.snapcraft.io/t/system-options/87