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.
*/

package metrics

import (
	"github.com/prometheus/client_golang/prometheus"
)

// Metrics contains the metrics for a certain subsystem name.
type Metrics struct {
	// PersistentVolumeClaimProvisionTotal is used to collect accumulated count of persistent volumes provisioned.
	PersistentVolumeClaimProvisionTotal *prometheus.CounterVec
	// PersistentVolumeClaimProvisionFailedTotal is used to collect accumulated count of persistent volume provision failed attempts.
	PersistentVolumeClaimProvisionFailedTotal *prometheus.CounterVec
	// PersistentVolumeClaimProvisionDurationSeconds is used to collect latency in seconds to provision persistent volumes.
	PersistentVolumeClaimProvisionDurationSeconds *prometheus.HistogramVec
	// PersistentVolumeDeleteTotal is used to collect accumulated count of persistent volumes deleted.
	PersistentVolumeDeleteTotal *prometheus.CounterVec
	// PersistentVolumeDeleteFailedTotal is used to collect accumulated count of persistent volume delete failed attempts.
	PersistentVolumeDeleteFailedTotal *prometheus.CounterVec
	// PersistentVolumeDeleteDurationSeconds is used to collect latency in seconds to delete persistent volumes.
	PersistentVolumeDeleteDurationSeconds *prometheus.HistogramVec
}

// New creates a new set of metrics with the goven subsystem name.
func New(subsystem string) Metrics {
	return Metrics{
		PersistentVolumeClaimProvisionTotal: prometheus.NewCounterVec(
			prometheus.CounterOpts{
				Subsystem: subsystem,
				Name:      "persistentvolumeclaim_provision_total",
				Help:      "Total number of persistent volumes provisioned succesfully. Broken down by storage class name and source of the claim.",
			},
			[]string{"class", "source"},
		),
		PersistentVolumeClaimProvisionFailedTotal: prometheus.NewCounterVec(
			prometheus.CounterOpts{
				Subsystem: subsystem,
				Name:      "persistentvolumeclaim_provision_failed_total",
				Help:      "Total number of persistent volume provision failed attempts. Broken down by storage class name and source of the claim.",
			},
			[]string{"class", "source"},
		),
		PersistentVolumeClaimProvisionDurationSeconds: prometheus.NewHistogramVec(
			prometheus.HistogramOpts{
				Subsystem: subsystem,
				Name:      "persistentvolumeclaim_provision_duration_seconds",
				Help:      "Latency in seconds to provision persistent volumes. Failed provisioning attempts are ignored. Broken down by storage class name and source of the claim.",
				Buckets:   prometheus.DefBuckets,
			},
			[]string{"class", "source"},
		),
		PersistentVolumeDeleteTotal: prometheus.NewCounterVec(
			prometheus.CounterOpts{
				Subsystem: subsystem,
				Name:      "persistentvolume_delete_total",
				Help:      "Total number of persistent volumes deleted succesfully. Broken down by storage class name.",
			},
			[]string{"class"},
		),
		PersistentVolumeDeleteFailedTotal: prometheus.NewCounterVec(
			prometheus.CounterOpts{
				Subsystem: subsystem,
				Name:      "persistentvolume_delete_failed_total",
				Help:      "Total number of persistent volume delete failed attempts. Broken down by storage class name.",
			},
			[]string{"class"},
		),
		PersistentVolumeDeleteDurationSeconds: prometheus.NewHistogramVec(
			prometheus.HistogramOpts{
				Subsystem: subsystem,
				Name:      "persistentvolume_delete_duration_seconds",
				Help:      "Latency in seconds to delete persistent volumes. Failed deletion attempts are ignored. Broken down by storage class name.",
				Buckets:   prometheus.DefBuckets,
			},
			[]string{"class"},
		),
	}
}