workqueue_metrics.go

/*
Copyright 2018 The Kubernetes Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

// This file comes from sigs.k8s.io/controller-runtime/pkg/metrics/workqueue.go

package controller

import (
	"github.com/prometheus/client_golang/prometheus"
	"k8s.io/client-go/util/workqueue"
)

// This file is copied and adapted from k8s.io/kubernetes/pkg/util/workqueue/prometheus
// which registers metrics to the default prometheus Registry. We require very
// similar functionality, but must register metrics to a different Registry.

func InitWorkQueueMetrics() {
	workqueue.SetProvider(workqueueMetricsProvider{})
}

func registerWorkqueueMetric(c prometheus.Collector, _, _ string) {
	prometheus.MustRegister(c)
}

type workqueueMetricsProvider struct{}

func (workqueueMetricsProvider) NewDepthMetric(queue string) workqueue.GaugeMetric {
	const name = "workqueue_depth"
	m := prometheus.NewGauge(prometheus.GaugeOpts{
		Name:        name,
		Help:        "Current depth of workqueue",
		ConstLabels: prometheus.Labels{"name": queue},
	})
	registerWorkqueueMetric(m, name, queue)
	return m
}

func (workqueueMetricsProvider) NewAddsMetric(queue string) workqueue.CounterMetric {
	const name = "workqueue_adds_total"
	m := prometheus.NewCounter(prometheus.CounterOpts{
		Name:        name,
		Help:        "Total number of adds handled by workqueue",
		ConstLabels: prometheus.Labels{"name": queue},
	})
	registerWorkqueueMetric(m, name, queue)
	return m
}

func (workqueueMetricsProvider) NewLatencyMetric(queue string) workqueue.HistogramMetric {
	const name = "workqueue_queue_duration_seconds"
	m := prometheus.NewHistogram(prometheus.HistogramOpts{
		Name:        name,
		Help:        "How long in seconds an item stays in workqueue before being requested.",
		ConstLabels: prometheus.Labels{"name": queue},
		Buckets:     prometheus.ExponentialBuckets(10e-9, 10, 10),
	})
	registerWorkqueueMetric(m, name, queue)
	return m
}

func (workqueueMetricsProvider) NewWorkDurationMetric(queue string) workqueue.HistogramMetric {
	const name = "workqueue_work_duration_seconds"
	m := prometheus.NewHistogram(prometheus.HistogramOpts{
		Name:        name,
		Help:        "How long in seconds processing an item from workqueue takes.",
		ConstLabels: prometheus.Labels{"name": queue},
		Buckets:     prometheus.ExponentialBuckets(10e-9, 10, 10),
	})
	registerWorkqueueMetric(m, name, queue)
	return m
}

func (workqueueMetricsProvider) NewUnfinishedWorkSecondsMetric(queue string) workqueue.SettableGaugeMetric {
	const name = "workqueue_unfinished_work_seconds"
	m := prometheus.NewGauge(prometheus.GaugeOpts{
		Name: name,
		Help: "How many seconds of work has done that " +
			"is in progress and hasn't been observed by work_duration. Large " +
			"values indicate stuck threads. One can deduce the number of stuck " +
			"threads by observing the rate at which this increases.",
		ConstLabels: prometheus.Labels{"name": queue},
	})
	registerWorkqueueMetric(m, name, queue)
	return m
}

func (workqueueMetricsProvider) NewLongestRunningProcessorSecondsMetric(queue string) workqueue.SettableGaugeMetric {
	const name = "workqueue_longest_running_processor_seconds"
	m := prometheus.NewGauge(prometheus.GaugeOpts{
		Name: name,
		Help: "How many seconds has the longest running " +
			"processor for workqueue been running.",
		ConstLabels: prometheus.Labels{"name": queue},
	})
	registerWorkqueueMetric(m, name, queue)
	return m
}

func (workqueueMetricsProvider) NewRetriesMetric(queue string) workqueue.CounterMetric {
	const name = "workqueue_retries_total"
	m := prometheus.NewCounter(prometheus.CounterOpts{
		Name:        name,
		Help:        "Total number of retries handled by workqueue",
		ConstLabels: prometheus.Labels{"name": queue},
	})
	registerWorkqueueMetric(m, name, queue)
	return m
}

// TODO(abursavich): Remove the following deprecated metrics when they are
// removed from k8s.io/client-go/util/workqueue.

func (workqueueMetricsProvider) NewDeprecatedLongestRunningProcessorMicrosecondsMetric(queue string) workqueue.SettableGaugeMetric {
	const name = "workqueue_longest_running_processor_microseconds"
	m := prometheus.NewGauge(prometheus.GaugeOpts{
		Name: name,
		Help: "(Deprecated) How many microseconds has the longest running " +
			"processor for workqueue been running.",
		ConstLabels: prometheus.Labels{"name": queue},
	})
	registerWorkqueueMetric(m, name, queue)
	return m
}

// NOTE: The following deprecated metrics are noops because they were never
// included in controller-runtime.

func (workqueueMetricsProvider) NewDeprecatedDepthMetric(_ string) workqueue.GaugeMetric {
	return noopMetric{}
}

func (workqueueMetricsProvider) NewDeprecatedAddsMetric(_ string) workqueue.CounterMetric {
	return noopMetric{}
}

func (workqueueMetricsProvider) NewDeprecatedLatencyMetric(_ string) workqueue.SummaryMetric {
	return noopMetric{}
}

func (workqueueMetricsProvider) NewDeprecatedWorkDurationMetric(_ string) workqueue.SummaryMetric {
	return noopMetric{}
}

func (workqueueMetricsProvider) NewDeprecatedUnfinishedWorkSecondsMetric(_ string) workqueue.SettableGaugeMetric {
	return noopMetric{}
}

func (workqueueMetricsProvider) NewDeprecatedRetriesMetric(_ string) workqueue.CounterMetric {
	return noopMetric{}
}

type noopMetric struct{}

func (noopMetric) Inc()            {}
func (noopMetric) Dec()            {}
func (noopMetric) Set(float64)     {}
func (noopMetric) Observe(float64) {}