[Metrics] Add expose function (#1043)

Author: ajanikow

internal/metrics.go

@@ -112,8 +112,9 @@ type Alerting struct {
 }
 
 type Label struct {
-	Key         string `json:"key" yaml:"key"`
-	Description string `json:"description" yaml:"description"`
+	Key         string  `json:"key" yaml:"key"`
+	Description string  `json:"description" yaml:"description"`
+	Type        *string `json:"type" yaml:"type"`
 }
 
 func GenerateMetricsDocumentation(root string, in MetricsDoc) error {
@@ -323,12 +324,32 @@ func generateMetricsGO(root string, in MetricsDoc) error {
 					}
 				}
 
+				var keys []string
+				var params []string
+
+				params = append(params, "value float64")
+				keys = append(keys, "value")
+
+				for _, label := range details.Labels {
+					k := strings.ToLower(label.Key)
+					keys = append(keys, k)
+
+					if t := label.Type; t != nil {
+						params = append(params, fmt.Sprintf("%s %s", k, *t))
+					} else {
+						params = append(params, fmt.Sprintf("%s string", k))
+					}
+				}
+
 				if err := i.Execute(out, map[string]interface{}{
 					"name":             mname,
 					"fname":            strings.Join(fnameParts, ""),
 					"ename":            strings.Join(tparts, ""),
 					"shortDescription": details.ShortDescription,
 					"labels":           generateLabels(details.Labels),
+					"type":             details.Type,
+					"fparams":          strings.Join(params, ", "),
+					"fkeys":            strings.Join(keys, ", "),
 				}); err != nil {
 					return err
 				}

internal/metrics.item.go.tmpl

@@ -32,4 +32,8 @@ func init() {
 
 func {{ .ename }}() metrics.Description {
     return {{ .fname }}
+}
+
+func {{ .ename }}{{ .type }}({{ .fparams }}) metrics.Metric {
+    return {{ .ename }}().Gauge({{ .fkeys }})
 }

pkg/deployment/agency/cache.go

@@ -57,29 +57,29 @@ func (h health) Leader() (driver.Connection, bool) {
 
 func (h health) CollectMetrics(m metrics.PushMetric) {
 	if err := h.Serving(); err == nil {
-		m.Push(metric_descriptions.ArangodbOperatorAgencyCacheServing().Gauge(1, h.namespace, h.name))
+		m.Push(metric_descriptions.ArangodbOperatorAgencyCacheServingGauge(1, h.namespace, h.name))
 	} else {
-		m.Push(metric_descriptions.ArangodbOperatorAgencyCacheServing().Gauge(0, h.namespace, h.name))
+		m.Push(metric_descriptions.ArangodbOperatorAgencyCacheServingGauge(0, h.namespace, h.name))
 	}
 
 	if err := h.Healthy(); err == nil {
-		m.Push(metric_descriptions.ArangodbOperatorAgencyCacheHealthy().Gauge(1, h.namespace, h.name))
+		m.Push(metric_descriptions.ArangodbOperatorAgencyCacheHealthyGauge(1, h.namespace, h.name))
 	} else {
-		m.Push(metric_descriptions.ArangodbOperatorAgencyCacheHealthy().Gauge(0, h.namespace, h.name))
+		m.Push(metric_descriptions.ArangodbOperatorAgencyCacheHealthyGauge(0, h.namespace, h.name))
 	}
 
 	for _, name := range h.names {
 		if i, ok := h.commitIndexes[name]; ok {
-			m.Push(metric_descriptions.ArangodbOperatorAgencyCacheMemberServing().Gauge(1, h.namespace, h.name, name),
-				metric_descriptions.ArangodbOperatorAgencyCacheMemberCommitOffset().Gauge(float64(i), h.namespace, h.name, name))
+			m.Push(metric_descriptions.ArangodbOperatorAgencyCacheMemberServingGauge(1, h.namespace, h.name, name),
+				metric_descriptions.ArangodbOperatorAgencyCacheMemberCommitOffsetGauge(float64(i), h.namespace, h.name, name))
 		} else {
-			m.Push(metric_descriptions.ArangodbOperatorAgencyCacheMemberServing().Gauge(0, h.namespace, h.name, name),
-				metric_descriptions.ArangodbOperatorAgencyCacheMemberCommitOffset().Gauge(-1, h.namespace, h.name, name))
+			m.Push(metric_descriptions.ArangodbOperatorAgencyCacheMemberServingGauge(0, h.namespace, h.name, name),
+				metric_descriptions.ArangodbOperatorAgencyCacheMemberCommitOffsetGauge(-1, h.namespace, h.name, name))
 		}
 	}
 
 	for k, l := range h.election {
-		m.Push(metric_descriptions.ArangodbOperatorAgencyCacheLeaders().Gauge(float64(l), h.namespace, h.name, k))
+		m.Push(metric_descriptions.ArangodbOperatorAgencyCacheLeadersGauge(float64(l), h.namespace, h.name, k))
 	}
 }
 

pkg/deployment/metrics.go

@@ -157,20 +157,20 @@ func (i *inventory) Add(d *Deployment) {
 }
 
 func (d *Deployment) CollectMetrics(m metrics.PushMetric) {
-	m.Push(metric_descriptions.ArangodbOperatorAgencyErrors().Gauge(float64(d.metrics.agency.errors), d.namespace, d.name))
-	m.Push(metric_descriptions.ArangodbOperatorAgencyFetches().Gauge(float64(d.metrics.agency.fetches), d.namespace, d.name))
-	m.Push(metric_descriptions.ArangodbOperatorAgencyIndex().Gauge(float64(d.metrics.agency.index), d.namespace, d.name))
+	m.Push(metric_descriptions.ArangodbOperatorAgencyErrorsCount(float64(d.metrics.agency.errors), d.namespace, d.name))
+	m.Push(metric_descriptions.ArangodbOperatorAgencyFetchesCount(float64(d.metrics.agency.fetches), d.namespace, d.name))
+	m.Push(metric_descriptions.ArangodbOperatorAgencyIndexGauge(float64(d.metrics.agency.index), d.namespace, d.name))
 
 	if c := d.agencyCache; c != nil {
-		m.Push(metric_descriptions.ArangodbOperatorAgencyCachePresent().Gauge(1, d.namespace, d.name))
+		m.Push(metric_descriptions.ArangodbOperatorAgencyCachePresentGauge(1, d.namespace, d.name))
 		if h, ok := c.Health(); ok {
-			m.Push(metric_descriptions.ArangodbOperatorAgencyCacheHealthPresent().Gauge(1, d.namespace, d.name))
+			m.Push(metric_descriptions.ArangodbOperatorAgencyCacheHealthPresentGauge(1, d.namespace, d.name))
 
 			h.CollectMetrics(m)
 		} else {
-			m.Push(metric_descriptions.ArangodbOperatorAgencyCacheHealthPresent().Gauge(0, d.namespace, d.name))
+			m.Push(metric_descriptions.ArangodbOperatorAgencyCacheHealthPresentGauge(0, d.namespace, d.name))
 		}
 	} else {
-		m.Push(metric_descriptions.ArangodbOperatorAgencyCachePresent().Gauge(0, d.namespace, d.name))
+		m.Push(metric_descriptions.ArangodbOperatorAgencyCachePresentGauge(0, d.namespace, d.name))
 	}
 }