Skip to content

Metrics: Expose X-Ratelimit-Used and X-Ratelimit-Reset as metric #438

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bluekeyes merged 2 commits into from
Mar 16, 2025
Merged

Metrics: Expose X-Ratelimit-Used and X-Ratelimit-Reset as metric #438

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
10667f9
Metrics: Add X-Ratelimit-Used as metric
andygrunwald Mar 16, 2025
d18d399
Metrics: Add X-Ratelimit-Reset as metric
andygrunwald Mar 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion githubapp/middleware.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ const (

MetricsKeyRateLimit = "github.rate.limit"
MetricsKeyRateLimitRemaining = "github.rate.remaining"
MetricsKeyRateLimitUsed = "github.rate.used"
MetricsKeyRateLimitReset = "github.rate.reset"
)

// ClientMetrics creates client middleware that records metrics about all
Expand Down Expand Up @@ -73,11 +75,15 @@ func ClientMetrics(registry metrics.Registry) ClientMiddleware {

limitMetric := fmt.Sprintf("%s[installation:%d]", MetricsKeyRateLimit, installationID)
remainingMetric := fmt.Sprintf("%s[installation:%d]", MetricsKeyRateLimitRemaining, installationID)
usedMetric := fmt.Sprintf("%s[installation:%d]", MetricsKeyRateLimitUsed, installationID)
resetMetric := fmt.Sprintf("%s[installation:%d]", MetricsKeyRateLimitReset, installationID)

// Headers from https://developer.github.com/v3/#rate-limiting
updateRegistryForHeader(res.Header, httpHeaderRateLimit, metrics.GetOrRegisterGauge(limitMetric, registry))
updateRegistryForHeader(res.Header, httpHeaderRateRemaining, metrics.GetOrRegisterGauge(remainingMetric, registry))
// TODO Think about to add X-Ratelimit-Used, X-Ratelimit-Reset and X-Ratelimit-Resource as well
updateRegistryForHeader(res.Header, httpHeaderRateUsed, metrics.GetOrRegisterGauge(usedMetric, registry))
updateRegistryForHeader(res.Header, httpHeaderRateReset, metrics.GetOrRegisterGauge(resetMetric, registry))
// TODO Think about to add X-Ratelimit-Resource as well
}

return res, err
Expand Down