metrics

Documentation

Index

• Constants
• Variables
• func RecordMetrics(total *prometheus.CounterVec, duration *prometheus.HistogramVec, ...)

Constants

const (
	Completed = "true"  // Represents successful operation
	Failed    = "false" // Represents failed operation
)

Constants representing success or failure states as strings for the metrics labels.

Variables

var (
	NodePublishTotal = prometheus.NewCounterVec(
		prometheus.CounterOpts{
			Name: "csi_node_publish_total",
			Help: "Total number of NodePublishVolume calls"},
		[]string{"functionStatus"},
	)

	// NodePublishDuration tracks the duration of NodePublishVolume calls.
	// It also uses a "functionStatus" label to capture whether the call succeeded or failed.
	NodePublishDuration = prometheus.NewHistogramVec(
		prometheus.HistogramOpts{
			Name:    "csi_node_publish_duration_seconds",
			Help:    "Duration of NodePublishVolume calls",
			Buckets: prometheus.DefBuckets,
		},
		[]string{"functionStatus"},
	)

	// NodeUnpublishTotal counts the total number of NodeUnpublishVolume calls.
	NodeUnpublishTotal = prometheus.NewCounterVec(
		prometheus.CounterOpts{
			Name: "csi_node_unpublish_total",
			Help: "Total number of NodeUnpublishVolume calls",
		},
		[]string{"functionStatus"},
	)

	// NodeUnpublishDuration tracks the duration of NodeUnpublishVolume calls.
	NodeUnpublishDuration = prometheus.NewHistogramVec(
		prometheus.HistogramOpts{
			Name:    "csi_node_unpublish_duration_seconds",
			Help:    "Duration of NodeUnpublishVolume calls",
			Buckets: prometheus.DefBuckets,
		},
		[]string{"functionStatus"},
	)

	// NodeStageVolumeTotal counts the total number of NodeStageVolume calls.
	NodeStageVolumeTotal = prometheus.NewCounterVec(
		prometheus.CounterOpts{
			Name: "csi_node_stage_volume_total",
			Help: "Total number of NodeStageVolume calls",
		},
		[]string{"functionStatus"},
	)

	// NodeStageVolumeDuration tracks the duration of NodeStageVolume calls.
	NodeStageVolumeDuration = prometheus.NewHistogramVec(
		prometheus.HistogramOpts{
			Name:    "csi_node_stage_volume_duration_seconds",
			Help:    "Duration of NodeStageVolume calls",
			Buckets: prometheus.DefBuckets,
		},
		[]string{"functionStatus"},
	)

	// NodeUnstageVolumeTotal counts the total number of NodeUnstageVolume calls.
	NodeUnstageVolumeTotal = prometheus.NewCounterVec(
		prometheus.CounterOpts{
			Name: "csi_node_unstage_volume_total",
			Help: "Total number of NodeUnstageVolume calls",
		},
		[]string{"functionStatus"},
	)

	// NodeUnstageVolumeDuration tracks the duration of NodeUnstageVolume calls.
	NodeUnstageVolumeDuration = prometheus.NewHistogramVec(
		prometheus.HistogramOpts{
			Name:    "csi_node_unstage_volume_duration_seconds",
			Help:    "Duration of NodeUnstageVolume calls",
			Buckets: prometheus.DefBuckets,
		},
		[]string{"functionStatus"},
	)

	// NodeExpandTotal counts the total number of NodeExpandVolume calls.
	NodeExpandTotal = prometheus.NewCounterVec(
		prometheus.CounterOpts{
			Name: "csi_node_expand_total",
			Help: "Total number of NodeExpandVolume calls",
		},
		[]string{"functionStatus"},
	)

	// NodeExpandDuration tracks the duration of NodeExpandVolume calls.
	NodeExpandDuration = prometheus.NewHistogramVec(
		prometheus.HistogramOpts{
			Name:    "csi_node_expand_duration_seconds",
			Help:    "Duration of NodeExpandVolume calls",
			Buckets: prometheus.DefBuckets,
		},
		[]string{"functionStatus"},
	)
)

NodePublishTotal counts the total number of NodePublishVolume calls. It uses a label "functionStatus" to differentiate between successful and failed calls.

var (
	// ControllerCreateVolumeTotal counts the total number of create volume calls.
	ControllerCreateVolumeTotal = prometheus.NewCounterVec(
		prometheus.CounterOpts{
			Name: "csi_controller_create_volume_total",
			Help: "Total number of Create Volume calls",
		},
		[]string{"functionStatus"},
	)

	// ControllerCreateVolumeDuration tracks the duration of create volume calls.
	ControllerCreateVolumeDuration = prometheus.NewHistogramVec(
		prometheus.HistogramOpts{
			Name: "csi_controller_create_volume_duration_seconds",
			Help: "Duration of Create Volume calls",
		},
		[]string{"functionStatus"},
	)

	// ControllerDeleteVolumeTotal counts the total number of delete volume calls.
	ControllerDeleteVolumeTotal = prometheus.NewCounterVec(
		prometheus.CounterOpts{
			Name: "csi_controller_delete_volume_total",
			Help: "Total number of Delete Volume calls",
		},
		[]string{"functionStatus"},
	)

	// ControllerDeleteVolumeDuration tracks the duration of delete volume calls.
	ControllerDeleteVolumeDuration = prometheus.NewHistogramVec(
		prometheus.HistogramOpts{
			Name: "csi_controller_delete_volume_duration_seconds",
			Help: "Duration of Delete Volume calls",
		},
		[]string{"functionStatus"},
	)

	// ControllerPublishVolumeTotal counts the total number of publish volume calls.
	ControllerPublishVolumeTotal = prometheus.NewCounterVec(
		prometheus.CounterOpts{
			Name: "csi_controller_publish_volume_total",
			Help: "Total number of Publish Volume calls",
		},
		[]string{"functionStatus"},
	)

	// ControllerPublishVolumeDuration tracks the duration of publish volume calls.
	ControllerPublishVolumeDuration = prometheus.NewHistogramVec(
		prometheus.HistogramOpts{
			Name: "csi_controller_publish_volume_duration_seconds",
			Help: "Duration of Publish Volume calls",
		},
		[]string{"functionStatus"},
	)

	// ControllerUnpublishVolumeTotal counts the total number of unpublish volume calls.
	ControllerUnpublishVolumeTotal = prometheus.NewCounterVec(
		prometheus.CounterOpts{
			Name: "csi_controller_unpublish_volume_total",
			Help: "Total number of Unpublish Volume calls",
		},
		[]string{"functionStatus"},
	)

	// ControllerUnpublishVolumeDuration tracks the duration of unpublish volume calls.
	ControllerUnpublishVolumeDuration = prometheus.NewHistogramVec(
		prometheus.HistogramOpts{
			Name: "csi_controller_unpublish_volume_duration_seconds",
			Help: "Duration of Unpublish Volume calls",
		},
		[]string{"functionStatus"},
	)
)

Functions

func RecordMetrics

func RecordMetrics(total *prometheus.CounterVec, duration *prometheus.HistogramVec, functionStatus string, start time.Time)

RecordMetrics function is a helper to encapsulate metrics storage across function calls. It increments the total counter and observes the duration of the operation.