Update README for Prometheus Client Output #2452
Conversation
| @@ -1,6 +1,13 @@ | |||
| # 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. | |||
There was a problem hiding this comment.
The original wording made more sense to me when the port was the only configuration option. When the following block shows the example config it seems odd to specifically call out the port here.
Additionally the config was referred to as port here and address within the example config.
It also seemed important to note that all metrics collected by Telegraf are exposed by the Prometheus client.
| ## Configuration | ||
|
|
||
| # Publish all metrics to /metrics for Prometheus to scrape | ||
| [[outputs.prometheus_client]] |
There was a problem hiding this comment.
this should be in an unindented code block, ie, with "```" on either side. See other plugin readmes for an example.
|
@sparrc The other thing I was considering was listing the required and optional parameters. Similar to: https://github.com/influxdata/telegraf/tree/master/plugins/outputs/kafka but this felt like overkill. Thoughts? |
|
yes, probably overkill |
|
@trastle are you still planning to update or would you like me to finish this up? |
|
@danielnelson sorry completely forgot about this. @sparrc I have made the requested formatting changes. Sorry for the delay. |
Update the README of the Prometheus Output with the example configuration.