Add Prometheus Exporter docs #1166
Conversation
danotorrey
changed the title
|
@bernd @dulanism Since this will be included in the 4.1 release, and some users are wanting to utilize it, I wanted to add some docs for it in time. If you can find the time to do an initial review of this tomorrow (Friday) or Monday morning, that would be really helpful. I would like to try and merge this on Monday so that it will be ready to go on release day. Thanks! |
pages/metrics.rst
Outdated
| prometheus_exporter_bind_address = 10.0.0.1:9090 | ||
|
|
||
| Depending on the current Prometheus `scrape_config setting <https://eus.io/docs/prometheus/latest/configuration/configuration/#scrape_config>`_, | ||
| the Graylog Prometheus exporter may be discovered automatically, or an explicit scrape target might need to be |
There was a problem hiding this comment.
How would the exporter be discovered automatically? Is there a way to do that? 🙂
There was a problem hiding this comment.
Thanks for seeing this. From a second-look, I think I misunderstood how the automatic discovery works. It looks like this is only supported in some special configurations (such as Kubernetes setups) where the list of cluster host names is already known through other means. It's not really applicable for the purposes of this docs page.
I have re-worded this section to be a bit more general and not reference auto-discovery.
Co-authored-by: Bernd Ahlers <bernd@users.noreply.github.com>
…eus-exports # Conflicts: # pages/metrics.rst
Add documentation for the new core Prometheus Exporter feature (originally implemented in Graylog2/graylog2-server#10767).
We did not yet have a main area in the docs where the Metrics topic is covered, so I added one so I have added a new top-level page titled
Metrics. I added a general description of standard Graylog metrics at the top as a prelude to discussing Prometheus exports in detail.A bulk of the Metrics page described the new Prometheus exporting functionality. It ended up a bit more extensive than I was originally thinking, but I think most of the content will be useful for those who really want to fully utilize the feature.
This was written in a rush, so hopefully this all makes sense :D
Closes #1154