wording

Emyrk · Emyrk · commit a661a40972a8 · 2024-01-10T08:59:49.000-06:00
diff --git a/coderd/promoauth/github.go b/coderd/promoauth/github.go
@@ -28,7 +28,7 @@ func githubRateLimits(resp *http.Response, err error) (rateLimits, bool) {
 		Limit:     p.int("x-ratelimit-limit"),
 		Remaining: p.int("x-ratelimit-remaining"),
 		Used:      p.int("x-ratelimit-used"),
-		Resource:  p.header.Get("x-ratelimit-resource"),
+		Resource:  p.string("x-ratelimit-resource"),
 	}
 
 	if limits.Limit == 0 &&
@@ -74,7 +74,7 @@ type headerParser struct {
 	header http.Header
 }
 
-func (p *headerParser) int(key string) int {
+func (p *headerParser) string(key string) string {
 	if p.errors == nil {
 		p.errors = make(map[string]error)
 	}
@@ -83,6 +83,14 @@ func (p *headerParser) int(key string) int {
 	if v == "" {
 		p.errors[key] = fmt.Errorf("missing header %q", key)
 	}
+	return v
+}
+
+func (p *headerParser) int(key string) int {
+	v := p.string(key)
+	if v == "" {
+		return -1
+	}
 
 	i, err := strconv.Atoi(v)
 	if err != nil {
diff --git a/coderd/promoauth/oauth2.go b/coderd/promoauth/oauth2.go
@@ -60,9 +60,11 @@ type metrics struct {
 	rateLimit          *prometheus.GaugeVec
 	rateLimitRemaining *prometheus.GaugeVec
 	rateLimitUsed      *prometheus.GaugeVec
-	// rateLimitReset is the time in seconds the rate limit resets.
+	// rateLimitReset is unix time of the next interval (when the rate limit resets).
 	rateLimitReset *prometheus.GaugeVec
 	// rateLimitResetIn is the time in seconds until the rate limit resets.
+	// This is included because it is sometimes more helpful to know the limit
+	// will reset in 600seconds, rather than at 1704000000 unix time.
 	rateLimitResetIn *prometheus.GaugeVec
 }
 
@@ -114,7 +116,7 @@ func NewFactory(registry prometheus.Registerer) *Factory {
 				Namespace: "coderd",
 				Subsystem: "oauth2",
 				Name:      "external_requests_rate_limit_next_reset_unix",
-				Help:      "Unix timestamp of the next interval",
+				Help:      "Unix timestamp for when the next interval starts",
 			}, []string{
 				"name",
 				"resource",
