lourenco/mgmt
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

documentation: prometheus: Improvements

Browse Source 
Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
This commit is contained in:
Julien Pivotto
2017-02-13 21:54:44 +01:00
parent 3261c405bd
commit b9976cf693
1 changed files with 12 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/prometheus.md
View File

@@ -24,15 +24,16 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
Mgmt comes with a built-in prometheus support. It is disabled by default, and Mgmt comes with a built-in prometheus support. It is disabled by default, and
can be enabled with the `--prometheus` command line switch. can be enabled with the `--prometheus` command line switch.
By default, the prometheus instance will listen on [`127.0.0.1:9233`][pd]. You can By default, the prometheus instance will listen on [`127.0.0.1:9233`][pd]. You
change this setting by using the `--prometheus-listen` cli option: can change this setting by using the `--prometheus-listen` cli option:
To have mgmt prometheus bind interface on 0.0.0.0:45001, use: To have mgmt prometheus bind interface on 0.0.0.0:45001, use:
`./mgmt r --prometheus --prometheus-listen :45001` `./mgmt r --prometheus --prometheus-listen :45001`
## Metrics ## Metrics
Mgmt exposes two kinds of resources: _go_ metrics and _mgmt_ metrics. Mgmt exposes three kinds of resources: _go_ metrics, _etcd_ metrics and _mgmt_
metrics.
### go metrics ### go metrics
@@ -48,13 +49,19 @@ mgmt exposes etcd metrics. Read more in the [upstream documentation][etcdm]
Here is a list of the metrics we provide: Here is a list of the metrics we provide:
- `mgmt_resources_total`: The number of resources that mgmt is managing - `mgmt_resources_total`: The number of resources that mgmt is managing
- `mgmt_checkapply_total`: The number of checkapplies that mgmt has run. - `mgmt_checkapply_total`: The number of CheckApply's that mgmt has run
- `mgmt_failures_total`: The number of resources that have failed - `mgmt_failures_total`: The number of resources that have failed
- `mgmt_failures_current`: 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: For each metric, you will get some extra labels:
- `resource_type`: The type of mgmt resource - `kind`: The kind of mgmt resource
For `mgmt_checkapply_total`, those extra labels are set:
- `eventful`: "true" or "false", if the CheckApply triggered some changes
- `errorful`: "true" or "false", if the CheckApply reported an error
- `apply`: "true" or "false", if the CheckApply ran in apply or noop mode
## Alerting ## Alerting