docs: document Prometheus PushGateway usage#7604
Open
won-seoop wants to merge 1 commit into
Open
Conversation
micrometer-metricsGH-4615: The Prometheus documentation did not mention the PushGateway at all. Added a new "Prometheus PushGateway" section covering: - Why/when to use the PushGateway (short-lived jobs, no scrape endpoint) - New client (prometheus-metrics-exporter-pushgateway): Maven/Gradle + code example - Legacy client (simpleclient_pushgateway): Maven/Gradle + code example - Note pointing to Spring Boot Actuator for Spring Boot users Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #4615
The Prometheus documentation page had no mention of the Prometheus PushGateway despite being a frequently asked about use case (see also #3661). PushGateway is a Prometheus Java Client feature, not a Micrometer feature, but documenting it here greatly helps users discover the option.
Added a new
== Prometheus PushGatewaysection toprometheus.adoccovering:micrometer-registry-prometheus): Maven/Gradle snippet +PushGateway.builder()code example usingprometheusRegistry.getPrometheusRegistry()micrometer-registry-prometheus-simpleclient): Maven/Gradle snippet +new PushGateway(host)code exampleNOTEpointing Spring Boot users to thePrometheusPushGatewayManagerin Spring Boot ActuatorTest plan