Add health endpoint #752
Merged
Add health endpoint #752
Conversation
This file contains 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
|
We should add this to the exporter toolkit as part of the landing page boilerplate functions. |
|
Yes, it would go to exporter-toolkit. Also note that Prometheus exposes /-/healthy. |
|
Hey folks, thanks for your quick reply. Unfortunately, I don't fully understand what you mean. Would you like to move the endpoint definition to the exporter-toolkit? And how would you like to combine it with the landing page boilerplate? The boiler plate exposes potentially sensitive data because it lists all probes. |
roidelapluie
reviewed
Mar 9, 2021
main.go
Outdated
| @@ -309,6 +309,10 @@ func run() int { | |||
| } | |||
| }) | |||
| http.Handle(path.Join(*routePrefix, "/metrics"), promhttp.Handler()) | |||
| http.HandleFunc(path.Join(*routePrefix, "/health"), func(w http.ResponseWriter, r *http.Request) { | |||
main.go
Outdated
| @@ -309,6 +309,10 @@ func run() int { | |||
| } | |||
| }) | |||
| http.Handle(path.Join(*routePrefix, "/metrics"), promhttp.Handler()) | |||
| http.HandleFunc(path.Join(*routePrefix, "/health"), func(w http.ResponseWriter, r *http.Request) { | |||
| w.WriteHeader(http.StatusOK) | |||
| w.Write([]byte("OK")) | |||
The root endpoint exposes too much data. So it cannot be used as public health check endpoint. Signed-off-by: Mitja Adebahr <[email protected]>
|
@SuperQ or @roidelapluie, can you please merge the PR? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The existing endpoints expose potentially sensitive data. So they cannot be used without authentication to check from the internet if the services is running.