From 0dcede784be8e1798aaefbd56718dda3187ea3e9 Mon Sep 17 00:00:00 2001 From: trastle Date: Mon, 19 Jun 2017 19:04:08 +0100 Subject: [PATCH] Update README for Prometheus Client Output (#2452) --- plugins/outputs/prometheus_client/README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/plugins/outputs/prometheus_client/README.md b/plugins/outputs/prometheus_client/README.md index 6ccb98a70..b9177ed7f 100644 --- a/plugins/outputs/prometheus_client/README.md +++ b/plugins/outputs/prometheus_client/README.md @@ -1,6 +1,15 @@ # Prometheus Client Service Output Plugin -This plugin starts a Prometheus Client, listening on a port defined in the -configuration file. +This plugin starts a [Prometheus](https://prometheus.io/) Client, it exposes all metrics on `/metrics` to be polled by a Prometheus server. -It exposes all metrics on `/metrics` to be polled by a Prometheus server. +## Configuration + +``` +# Publish all metrics to /metrics for Prometheus to scrape +[[outputs.prometheus_client]] + # Address to listen on + listen = ":9126" + + # Expiration interval for each metric. 0 == no expiration + expiration_interval = "60s" +```