lourenco/mgmt
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
5b29358b3742a11f702fcf48a4daf3a4dd69447a
mgmt/docs/prometheus.md
Julien Pivotto 1af67e72d4 prometheus: Implement basic Prometheus support 
Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
2017-02-08 12:13:33 +01:00

2.7 KiB
Raw Blame History

mgmt

Prometheus support

Mgmt comes with a built-in prometheus support. It is disabled by default, and can be enabled with the --prometheus command line switch.

By default, the prometheus instance will listen on 127.0.0.1:9233. You can change this setting by using the --prometheus-listen cli option:

To have mgmt prometheus bind interface on 0.0.0.0:45001, use: ./mgmt r --prometheus --prometheus-listen :45001

Metrics

Mgmt exposes two kinds of resources: go metrics and mgmt metrics.

go metrics

We use the prometheus go_collector to expose go metrics. Those metrics are mainly useful for debugging and perf testing.

etcd metrics

mgmt exposes etcd metrics. Read more in the upstream documentation

mgmt metrics

Here is a list of the metrics we provide:

  • mgmt_resources_total: The number of resources that mgmt is managing
  • mgmt_checkapply_total: The number of checkapplies that mgmt has run.
  • mgmt_failures_total: The number of resources that have failed
  • mgmt_failures_current: The number of resources that have failed

For each metric, you will get some extra labels:

  • resource_type: The type of mgmt resource

Alerting

You can use prometheus to alert you upon changes or failures. We do not provide such templates yet, but we plan to provide some examples in this repository. Patches welcome!

Grafana

We do not have grafana dashboards yet. Patches welcome!

External resources