Implement feature to capture metrics inside Dependabot Actions to post to Dependabot API #1428
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
pavera
approved these changes
Mar 13, 2025
honeyankit
commented
Mar 13, 2025
|
|
||
| // The sendMetrics function is used to send metrics to the API client. | ||
| // It uses the package manager as a tag to identify the metric. | ||
| const sendMetricsWithPackageManager: MetricReporter = async ( |
Contributor
Author
There was a problem hiding this comment.
I’ve introduced a wrapper around sendMetrics to pass it into ImageService.pull. This approach avoids significant changes to the existing interface by adding a thin layer to capture the package manager information. This way, we don’t need to extensively modify ImageService while still ensuring metrics are accurately captured.
pavera
approved these changes
Mar 13, 2025
Contributor
Author
|
Metrics are getting successfully: |
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.
Context
Implement metrics collection in
dependabot-actionsto track calls toGitHub’s private registryby sending data to Dependabot API’srecord_metrics. This enhancement will allow us to measure the frequency of image pulls from GitHub’s private registry. Previously, no metrics were captured withindependabot-actions, limiting our visibility into registry usage rates.Approach
sendMetricsfunction within the existing ApiClient class, allowing metric reporting.ImageService.pullmethod to accept an optional MetricReporter parameter, ensuring metrics are reported only when explicitly passed. This prevents unwanted metric reporting in scripts like fetch-image.ts that reuse the same image pulling logic but do not require metrics during unit-tests.Tradeoffs
This change introduces two additional calls per Dependabot Actions run to the Dependabot API’s record_metrics endpoint, effectively doubling the number of requests—two million API requests for one million action runs. Batch processing isn’t feasible here, as each Dependabot Actions run occurs independently, requiring immediate collection and posting of metrics via the sendMetrics function. These metrics are then forwarded from Dependabot API to Datadog. Given this constraint, monitoring the API performance closely will be essential to ensure reliability.
Q. Why we cannot directly install Datadog agent in
dependabot-actionsand send the metrics to the Data Dog server instead?Ephemeral Container Billing: Each time proxy container (with the embedded Datadog Agent) runs, it’s considered a separate host instance. Even if these containers are short-lived, they are counted individually for billing purposes.
Referenced: #1156