From 7f91379373300edc475cdf5e7570798de890ea40 Mon Sep 17 00:00:00 2001
From: Will Norris <will@willnorris.com>
Date: Mon, 24 Feb 2020 08:16:36 -0800
Subject: [PATCH] rename prometheus metrics and vars

Make names a little more consistent and align with naming docs at
https://prometheus.io/docs/practices/naming/
---
 imageproxy.go |  6 +++---
 metrics.go    | 33 ++++++++++++++++++---------------
 transform.go  |  2 +-
 3 files changed, 22 insertions(+), 19 deletions(-)

diff --git a/imageproxy.go b/imageproxy.go
index 3163dba..6721056 100644
--- a/imageproxy.go
+++ b/imageproxy.go
@@ -150,7 +150,7 @@ func (p *Proxy) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 		h = tphttp.TimeoutHandler(h, p.Timeout, "Gateway timeout waiting for remote resource.")
 	}
 
-	timer := prometheus.NewTimer(httpRequestsResponseTime)
+	timer := prometheus.NewTimer(metricRequestDuration)
 	defer timer.ObserveDuration()
 	h.ServeHTTP(w, r)
 }
@@ -191,7 +191,7 @@ func (p *Proxy) serveImage(w http.ResponseWriter, r *http.Request) {
 		msg := fmt.Sprintf("error fetching remote image: %v", err)
 		p.log(msg)
 		http.Error(w, msg, http.StatusInternalServerError)
-		remoteImageFetchErrors.Inc()
+		metricRemoteErrors.Inc()
 		return
 	}
 	// close the original resp.Body, even if we wrap it in a NopCloser below
@@ -203,7 +203,7 @@ func (p *Proxy) serveImage(w http.ResponseWriter, r *http.Request) {
 	}
 
 	if cached {
-		requestServedFromCacheCount.Inc()
+		metricServedFromCache.Inc()
 	}
 
 	copyHeader(w.Header(), resp.Header, "Cache-Control", "Last-Modified", "Expires", "Etag", "Link")
diff --git a/metrics.go b/metrics.go
index 5b405a9..e2d870a 100644
--- a/metrics.go
+++ b/metrics.go
@@ -5,29 +5,32 @@ import (
 )
 
 var (
-	requestServedFromCacheCount = prometheus.NewCounter(
+	metricServedFromCache = prometheus.NewCounter(
 		prometheus.CounterOpts{
-			Name: "requests_served_from_cache",
-			Help: "Number of requests served from cache.",
+			Namespace: "imageproxy",
+			Name:      "requests_served_from_cache_total",
+			Help:      "Number of requests served from cache.",
 		})
-	imageTransformationSummary = prometheus.NewSummary(prometheus.SummaryOpts{
-		Name: "image_transformation_seconds",
-		Help: "Time taken for image transformations in seconds.",
+	metricTransformationDuration = prometheus.NewSummary(prometheus.SummaryOpts{
+		Namespace: "imageproxy",
+		Name:      "transformation_duration_seconds",
+		Help:      "Time taken for image transformations in seconds.",
 	})
-	remoteImageFetchErrors = prometheus.NewCounter(prometheus.CounterOpts{
-		Name: "remote_image_fetch_errors",
-		Help: "Total image fetch failures",
+	metricRemoteErrors = prometheus.NewCounter(prometheus.CounterOpts{
+		Namespace: "imageproxy",
+		Name:      "remote_fetch_errors_total",
+		Help:      "Total remote image fetch errors",
 	})
-	httpRequestsResponseTime = prometheus.NewSummary(prometheus.SummaryOpts{
+	metricRequestDuration = prometheus.NewSummary(prometheus.SummaryOpts{
 		Namespace: "http",
-		Name:      "response_time_seconds",
+		Name:      "request_duration_seconds",
 		Help:      "Request response times",
 	})
 )
 
 func init() {
-	prometheus.MustRegister(imageTransformationSummary)
-	prometheus.MustRegister(requestServedFromCacheCount)
-	prometheus.MustRegister(remoteImageFetchErrors)
-	prometheus.MustRegister(httpRequestsResponseTime)
+	prometheus.MustRegister(metricTransformationDuration)
+	prometheus.MustRegister(metricServedFromCache)
+	prometheus.MustRegister(metricRemoteErrors)
+	prometheus.MustRegister(metricRequestDuration)
 }
diff --git a/transform.go b/transform.go
index da636b5..ed772e0 100644
--- a/transform.go
+++ b/transform.go
@@ -275,7 +275,7 @@ func exifOrientation(r io.Reader) (opt Options) {
 // transformImage modifies the image m based on the transformations specified
 // in opt.
 func transformImage(m image.Image, opt Options) image.Image {
-	timer := prometheus.NewTimer(imageTransformationSummary)
+	timer := prometheus.NewTimer(metricTransformationDuration)
 	defer timer.ObserveDuration()
 
 	// Parse crop and resize parameters before applying any transforms.