support scraping additional metrics #100
Closed
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
cbodonnell
commented
Oct 9, 2023
| @@ -56,3 +56,4 @@ isAirgap: false | |||
| userAgent: "" | |||
| replicatedID: "" | |||
| appID: "" | |||
| additionalMetricsEndpoint: "" | |||
There was a problem hiding this comment.
thoughts on supporting multiple endpoints here? asking because it's what copilot kept trying to guide me towards :)
sgalsaleh
reviewed
Oct 10, 2023
| if sdkStore.GetAdditionalMetricsEndpoint() != "" { | ||
| additionalMetrics, err := getAdditionalMetrics(sdkStore.GetAdditionalMetricsEndpoint(), sdkStore.GetLicense().Spec.LicenseID) | ||
| if err != nil { | ||
| logger.Errorf("failed to get additional metrics: %v", err.Error()) |
There was a problem hiding this comment.
hmm, only logging an error and continuing to report without the additional metrics can be problematic. let's discuss.
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.
What this PR does / why we need it:
This PR adds support for an
additionalMetricsEndpointconfiguration value. When configured, the SDK will scrape the endpoint for additional metrics to be reported along with its standard heartbeat data. The endpoint should return a json payload containing key-value pairs in the format:Which issue(s) this PR fixes:
https://app.shortcut.com/replicated/story/88175/add-a-helm-value-to-the-sdk-to-accept-an-endpoint-where-it-retrieves-additional-metrics-to-be-reported
Special notes for your reviewer:
Steps to reproduce
Does this PR introduce a user-facing change?
Does this PR require documentation?