pkg/metrics/openstack.go add openstack api request metrics

Signed-off-by: Schlotter, Christian <[email protected]>

Author: chrischdi

docs/metrics.md

@@ -107,18 +107,20 @@ func ScrapeCinderMetrics(client *gophercloud.ServiceClient, clientset *kubernete
 	cinderVolumeAttachedAt.Reset()
 
 	// get all volumes and scrape them
+	mc := newOpenStackMetric("volume", "list")
 	pager := volumes.List(client, volumes.ListOpts{})
 	err = pager.EachPage(func(page pagination.Page) (bool, error) {
 		return scrapeVolumesPage(page, pvs)
 	})
-	if err != nil {
+	if mc.Observe(err) != nil {
 		// only warn, maybe the next scrape will work.
 		klog.Warningf("Unable to scrape volumes: %v", err)
 		return err
 	}
 
+	mc = newOpenStackMetric("volume_quotasets_usage", "get")
 	q, err := quotasets.GetUsage(client, tenantID).Extract()
-	if err != nil {
+	if mc.Observe(err) != nil {
 		// only warn, maybe the next scrape will work.
 		klog.Warningf("Unable to scrape quotas: %v", err)
 		return err

pkg/metrics/cinder.go

@@ -43,8 +43,9 @@ func registerLoadBalancerMetrics() {
 // passes the result to a scrape function.
 func ScrapeLoadBalancerMetrics(client *gophercloud.ServiceClient, tenantID string) error {
 	// first step: gather the data
+	mc := newOpenStackMetric("loadbalancer", "list")
 	pages, err := loadbalancers.List(client, loadbalancers.ListOpts{}).AllPages()
-	if err != nil {
+	if mc.Observe(err) != nil {
 		// only warn, maybe the next scrape will work.
 		klog.Warningf("Unable to scrape floating ips: %v", err)
 		return err

pkg/metrics/loadbalancer.go

@@ -21,6 +21,7 @@ func RegisterMetrics(prefix string) {
 	registerCinderMetrics()
 	registerNeutronMetrics()
 	registerLoadBalancerMetrics()
+	registerOpenStackMetrics()
 }
 
 // AddPrefix adds the given prefix to the string, if set

pkg/metrics/metrics.go

@@ -49,8 +49,9 @@ func registerNeutronMetrics() {
 // the result to a scrape function.
 func ScrapeNeutronMetrics(neutronClient *gophercloud.ServiceClient, tenantID string) error {
 	// first step: gather the data
+	mc := newOpenStackMetric("floating_ip", "list")
 	pages, err := floatingips.List(neutronClient, floatingips.ListOpts{}).AllPages()
-	if err != nil {
+	if mc.Observe(err) != nil {
 		// only warn, maybe the next scrape will work.
 		klog.Warningf("Unable to scrape floating ips: %v", err)
 		return err

pkg/metrics/neutron.go

@@ -0,0 +1,68 @@
+// SPDX-License-Identifier: MIT
+
+package metrics
+
+import (
+	"time"
+
+	"github.com/prometheus/client_golang/prometheus"
+)
+
+type openstackMetrics struct {
+	duration *prometheus.HistogramVec
+	total    *prometheus.CounterVec
+	errors   *prometheus.CounterVec
+}
+
+var (
+	requestMetrics *openstackMetrics
+)
+
+func registerOpenStackMetrics() {
+	requestMetrics = &openstackMetrics{
+		duration: prometheus.NewHistogramVec(
+			prometheus.HistogramOpts{
+				Name: generateName("openstack_api_request_duration_seconds"),
+				Help: "Latency of an OpenStack API call",
+			}, []string{"request"}),
+		total: prometheus.NewCounterVec(
+			prometheus.CounterOpts{
+				Name: generateName("openstack_api_requests_total"),
+				Help: "Total number of OpenStack API calls",
+			}, []string{"request"}),
+		errors: prometheus.NewCounterVec(
+			prometheus.CounterOpts{
+				Name: generateName("openstack_api_request_errors_total"),
+				Help: "Total number of errors for an OpenStack API call",
+			}, []string{"request"}),
+	}
+
+	prometheus.MustRegister(requestMetrics.duration)
+	prometheus.MustRegister(requestMetrics.total)
+	prometheus.MustRegister(requestMetrics.errors)
+}
+
+// openStackMetric indicates the context for OpenStack metrics.
+type openStackMetric struct {
+	start      time.Time
+	attributes []string
+}
+
+// newOpenStackMetric creates a new MetricContext.
+func newOpenStackMetric(resource string, request string) *openStackMetric {
+	return &openStackMetric{
+		start:      time.Now(),
+		attributes: []string{resource + "_" + request},
+	}
+}
+
+// Observe records the request latency and counts the errors.
+func (mc *openStackMetric) Observe(err error) error {
+	requestMetrics.duration.WithLabelValues(mc.attributes...).Observe(
+		time.Since(mc.start).Seconds())
+	requestMetrics.total.WithLabelValues(mc.attributes...).Inc()
+	if err != nil {
+		requestMetrics.errors.WithLabelValues(mc.attributes...).Inc()
+	}
+	return err
+}