[ENHANCEMENT] Implement the healthcheck method for Prometheus datasources
#1595
Conversation
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
The `DatasourceClient` interface defines a `healthcheck` method, which hasn't actually been implemented. This implements it for the `PrometheusDatasourceClient` as a first step towards being able to test the health of a datasource. The actual implementation calls the [/-/healthy](https://prometheus.io/docs/prometheus/latest/management_api/#health-check) endpoint in the Prometheus API, rather than running a query. I figured this was a better way to test the health rather than running a dummy query and checking the result, as running a query is a more expensive and subjects us to the vagaries of PromQL, and potential query timeouts which aren't directly related to whether the datasource is configured correctly. Signed-off-by: sinkingpoint <colin@quirl.co.nz>
e25778e to
78a4647
Compare
|
Amazing @sinkingpoint thanks for handling this. |
nicolastakashi
approved these changes
Nov 21, 2023
Gladorme
reviewed
Nov 22, 2023
| @@ -37,6 +37,7 @@ const createClient: DatasourcePlugin<PrometheusDatasourceSpec, PrometheusClient> | |||
| options: { | |||
| datasourceUrl, | |||
| }, | |||
| healthCheck: healthCheck({ datasourceUrl, headers: specHeaders }), | |||
There was a problem hiding this comment.
For similarity with others requests, I would have add headers as param too. But I guess it's fine 🤔
Suggested change
| healthCheck: healthCheck({ datasourceUrl, headers: specHeaders }), | |
| healthCheck: (headers) => healthCheck({ datasourceUrl, headers: headers ?? specHeaders }), |
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.
Description
As a first step towards #1542 (and as my first PR, so feedback appreciated), this implements a healthcheck on Prometheus Datasources.
The
DatasourceClientinterface defines ahealthcheckmethod, whichhasn't actually been implemented. This implements it for the
PrometheusDatasourceClientas a first step towards being able to test the health of a datasource.
The actual implementation calls the /-/healthy
endpoint in the Prometheus API, rather than running a query. I figured
this was a better way to test the health rather than running a dummy
query and checking the result, as running a query is a more expensive
and subjects us to the vagaries of PromQL, and potential
query timeouts which aren't directly related to whether the datasource
is configured correctly.
Checklist
[<catalog_entry>] <commit message>naming convention using one of the followingcatalog_entryvalues:FEATURE,ENHANCEMENT,BUGFIX,BREAKINGCHANGE,IGNORE.