Skip to content
This repository has been archived by the owner on Oct 27, 2021. It is now read-only.

Add Prometheus Exporter docs #1166

Merged
merged 13 commits into from
Jun 21, 2021
Merged

Add Prometheus Exporter docs #1166

merged 13 commits into from
Jun 21, 2021

Conversation

danotorrey
Copy link
Contributor

@danotorrey danotorrey commented Jun 17, 2021

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

@danotorrey danotorrey marked this pull request as ready for review June 17, 2021 22:31
@danotorrey danotorrey requested a review from bernd June 17, 2021 22:33
@danotorrey danotorrey changed the title Add Metrics page with Prometheus Exporter section Add Prometheus Exporter docs Jun 17, 2021
@danotorrey
Copy link
Contributor Author

danotorrey commented Jun 17, 2021

@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!

@danotorrey danotorrey requested a review from dulanism June 17, 2021 22:38
@danotorrey danotorrey changed the base branch from 4.0 to 4.1 June 17, 2021 22:38
Copy link
Member

@bernd bernd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! 🙏 Only one comment and one question:

pages/metrics.rst Outdated Show resolved Hide resolved
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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How would the exporter be discovered automatically? Is there a way to do that? 🙂

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@danotorrey danotorrey requested a review from bernd June 18, 2021 14:25
@danotorrey danotorrey merged commit 15cdad0 into 4.1 Jun 21, 2021
@danotorrey danotorrey deleted the prometheus-exports branch June 21, 2021 18:28
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document new core Prometheus Exporter
2 participants