mirror of
https://github.com/ceph/ceph-csi.git
synced 2024-11-26 00:00:23 +00:00
129 lines
4.7 KiB
Go
129 lines
4.7 KiB
Go
/*
|
|
Copyright 2017 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.
|
|
*/
|
|
|
|
package util
|
|
|
|
import (
|
|
"fmt"
|
|
"time"
|
|
|
|
"k8s.io/component-base/metrics"
|
|
"k8s.io/component-base/metrics/legacyregistry"
|
|
"k8s.io/kubernetes/pkg/volume"
|
|
)
|
|
|
|
const (
|
|
statusSuccess = "success"
|
|
statusFailUnknown = "fail-unknown"
|
|
)
|
|
|
|
/*
|
|
* By default, all the following metrics are defined as falling under
|
|
* ALPHA stability level https://github.com/kubernetes/enhancements/blob/master/keps/sig-instrumentation/20190404-kubernetes-control-plane-metrics-stability.md#stability-classes)
|
|
*
|
|
* Promoting the stability level of the metric is a responsibility of the component owner, since it
|
|
* involves explicitly acknowledging support for the metric across multiple releases, in accordance with
|
|
* the metric stability policy.
|
|
*/
|
|
var storageOperationMetric = metrics.NewHistogramVec(
|
|
&metrics.HistogramOpts{
|
|
Name: "storage_operation_duration_seconds",
|
|
Help: "Storage operation duration",
|
|
Buckets: []float64{.1, .25, .5, 1, 2.5, 5, 10, 15, 25, 50, 120, 300, 600},
|
|
StabilityLevel: metrics.ALPHA,
|
|
},
|
|
[]string{"volume_plugin", "operation_name"},
|
|
)
|
|
|
|
var storageOperationErrorMetric = metrics.NewCounterVec(
|
|
&metrics.CounterOpts{
|
|
Name: "storage_operation_errors_total",
|
|
Help: "Storage operation errors",
|
|
StabilityLevel: metrics.ALPHA,
|
|
},
|
|
[]string{"volume_plugin", "operation_name"},
|
|
)
|
|
|
|
var storageOperationStatusMetric = metrics.NewCounterVec(
|
|
&metrics.CounterOpts{
|
|
Name: "storage_operation_status_count",
|
|
Help: "Storage operation return statuses count",
|
|
StabilityLevel: metrics.ALPHA,
|
|
},
|
|
[]string{"volume_plugin", "operation_name", "status"},
|
|
)
|
|
|
|
var storageOperationEndToEndLatencyMetric = metrics.NewHistogramVec(
|
|
&metrics.HistogramOpts{
|
|
Name: "volume_operation_total_seconds",
|
|
Help: "Storage operation end to end duration in seconds",
|
|
Buckets: []float64{.1, .25, .5, 1, 2.5, 5, 10, 15, 25, 50, 120, 300, 600},
|
|
StabilityLevel: metrics.ALPHA,
|
|
},
|
|
[]string{"plugin_name", "operation_name"},
|
|
)
|
|
|
|
func init() {
|
|
registerMetrics()
|
|
}
|
|
|
|
func registerMetrics() {
|
|
// legacyregistry is the internal k8s wrapper around the prometheus
|
|
// global registry, used specifically for metric stability enforcement
|
|
legacyregistry.MustRegister(storageOperationMetric)
|
|
legacyregistry.MustRegister(storageOperationErrorMetric)
|
|
legacyregistry.MustRegister(storageOperationStatusMetric)
|
|
legacyregistry.MustRegister(storageOperationEndToEndLatencyMetric)
|
|
}
|
|
|
|
// OperationCompleteHook returns a hook to call when an operation is completed
|
|
func OperationCompleteHook(plugin, operationName string) func(*error) {
|
|
requestTime := time.Now()
|
|
opComplete := func(err *error) {
|
|
timeTaken := time.Since(requestTime).Seconds()
|
|
// Create metric with operation name and plugin name
|
|
status := statusSuccess
|
|
if *err != nil {
|
|
// TODO: Establish well-known error codes to be able to distinguish
|
|
// user configuration errors from system errors.
|
|
status = statusFailUnknown
|
|
storageOperationErrorMetric.WithLabelValues(plugin, operationName).Inc()
|
|
} else {
|
|
storageOperationMetric.WithLabelValues(plugin, operationName).Observe(timeTaken)
|
|
}
|
|
storageOperationStatusMetric.WithLabelValues(plugin, operationName, status).Inc()
|
|
}
|
|
return opComplete
|
|
}
|
|
|
|
// GetFullQualifiedPluginNameForVolume returns full qualified plugin name for
|
|
// given volume. For CSI plugin, it appends plugin driver name at the end of
|
|
// plugin name, e.g. kubernetes.io/csi:csi-hostpath. It helps to distinguish
|
|
// between metrics emitted for CSI volumes which may be handled by different
|
|
// CSI plugin drivers.
|
|
func GetFullQualifiedPluginNameForVolume(pluginName string, spec *volume.Spec) string {
|
|
if spec != nil && spec.PersistentVolume != nil && spec.PersistentVolume.Spec.CSI != nil {
|
|
return fmt.Sprintf("%s:%s", pluginName, spec.PersistentVolume.Spec.CSI.Driver)
|
|
}
|
|
return pluginName
|
|
}
|
|
|
|
// RecordOperationLatencyMetric records the end to end latency for certain operation
|
|
// into metric volume_operation_total_seconds
|
|
func RecordOperationLatencyMetric(plugin, operationName string, secondsTaken float64) {
|
|
storageOperationEndToEndLatencyMetric.WithLabelValues(plugin, operationName).Observe(secondsTaken)
|
|
}
|