metrics

Documentation

Index

• Constants
• func AddMetricsTransportWrapper(metrics *CustomMetrics, config *rest.Config) *rest.Config
• type CustomMetrics
  • func RegisterCustomMetrics() *CustomMetrics
  • func (m *CustomMetrics) DecISBServiceMetrics(name, namespace string)
  • func (m *CustomMetrics) DecMonoVertexMetrics(name, namespace string)
  • func (m *CustomMetrics) DecPipelineMetrics(name, namespace string)
  • func (m *CustomMetrics) IncISBServiceMetrics(name, namespace string)
  • func (m *CustomMetrics) IncMonoVertexMetrics(name, namespace string)
  • func (m *CustomMetrics) IncPipelinesRunningMetrics(name, namespace string)

Constants

const (
	LabelIntuit             = "intuit_alert"
	LabelVersion            = "version"
	LabelType               = "type"
	LabelPhase              = "phase"
	LabelK8SVersion         = "K8SVersion"
	LabelName               = "name"
	LabelNamespace          = "namespace"
	LabelPipeline           = "pipeline"
	LabelISBService         = "isbservice"
	LabelNumaflowController = "numaflowcontroller"
	LabelMonoVertex         = "monovertex"
)

Functions

func AddMetricsTransportWrapper

func AddMetricsTransportWrapper(metrics *CustomMetrics, config *rest.Config) *rest.Config

AddMetricsTransportWrapper adds a transport wrapper which increments 'numaplane_app_k8s_request_total' counter on each kubernetes request

Types

type CustomMetrics

type CustomMetrics struct {
	// PipelinesHealth is the gauge for the health of pipelines.
	PipelinesHealth *prometheus.GaugeVec
	// PipelinesRunning is the gauge for the number of running pipelines.
	PipelinesRunning *prometheus.GaugeVec
	// PipelineCounterMap contains the information of all running pipelines.
	PipelineCounterMap map[string]map[string]struct{}
	// PipelinesSyncFailed is the counter for the total number of failed synced.
	PipelinesSyncFailed *prometheus.CounterVec
	// PipelineRolloutQueueLength is the gauge for the length of pipeline rollout queue.
	PipelineRolloutQueueLength *prometheus.GaugeVec
	// PipelinesSynced is the counter for the total number of pipelines synced.
	PipelinesSynced *prometheus.CounterVec
	// ISBServicesHealth is the gauge for the health of ISB services.
	ISBServicesHealth *prometheus.GaugeVec
	// ISBServicesRunning is the gauge for the number of running ISB services.
	ISBServicesRunning *prometheus.GaugeVec
	// ISBServiceCounterMap contains the information of all running ISB services.
	ISBServiceCounterMap map[string]map[string]struct{}
	// ISBServicesSyncFailed is the counter for the total number of ISB service syncing failed.
	ISBServicesSyncFailed *prometheus.CounterVec
	// ISBServicesSynced is the counter for the total number of ISB service synced.
	ISBServicesSynced *prometheus.CounterVec
	// MonoVerticesHealth is the gauge for the health of monovertices.
	MonoVerticesHealth *prometheus.GaugeVec
	// MonoVerticesRunning is the gauge for the number of running monovertices.
	MonoVerticesRunning *prometheus.GaugeVec
	// MonoVerticesCounterMap contains the information of all running monovertices.
	MonoVerticesCounterMap map[string]map[string]struct{}
	// MonoVerticesSyncFailed is the counter for the total number of monovertices syncing failed.
	MonoVerticesSyncFailed *prometheus.CounterVec
	// MonoVerticesSynced is the counter for the total number of monovertices synced.
	MonoVerticesSynced *prometheus.CounterVec
	// NumaflowControllersHealth is the gauge for the health of Numaflow controller.
	NumaflowControllersHealth *prometheus.GaugeVec
	// NumaflowControllerRunning is the gauge for the number of running numaflow controllers with a specific version.
	NumaflowControllerRunning *prometheus.GaugeVec
	// NumaflowControllersSyncFailed is the counter for the total number of Numaflow controller syncing failed.
	NumaflowControllersSyncFailed *prometheus.CounterVec
	// NumaflowControllersSynced in the counter for the total number of Numaflow controllers synced.
	NumaflowControllersSynced *prometheus.CounterVec
	// ReconciliationDuration is the histogram for the duration of pipeline, isb service, monovertex and numaflow controller reconciliation.
	ReconciliationDuration *prometheus.HistogramVec
	// NumaflowControllerKubectlExecutionCounter Count the number of kubectl executions during numaflow controller reconciliation
	NumaflowControllerKubectlExecutionCounter *prometheus.CounterVec
	// KubeRequestCounter Count the number of kubernetes requests during reconciliation
	KubeRequestCounter *prometheus.CounterVec
	// KubeResourceMonitored count the number of monitored kubernetes resource objects in cache
	KubeResourceMonitored *prometheus.GaugeVec
	// KubeResourceCache count the number of kubernetes resource objects in cache
	KubeResourceCache *prometheus.GaugeVec
	// ClusterCacheError count the total number of cluster cache errors
	ClusterCacheError *prometheus.CounterVec
	// PipelinePausedSeconds counts the total time a Pipeline was paused.
	PipelinePausedSeconds *prometheus.GaugeVec
	// ISBServicePausedSeconds counts the total time an ISBService requested resources be paused.
	ISBServicePausedSeconds *prometheus.GaugeVec
	// NumaflowControllerPausedSeconds counts the total time a Numaflow controller requested resources be paused.
	NumaflowControllerPausedSeconds *prometheus.GaugeVec
}

func RegisterCustomMetrics

func RegisterCustomMetrics() *CustomMetrics

RegisterCustomMetrics registers the custom metrics to the existing global prometheus registry for pipelines, ISB service and numaflow controller

func (*CustomMetrics) DecISBServiceMetrics

func (m *CustomMetrics) DecISBServiceMetrics(name, namespace string)

DecISBServiceMetrics decrements the ISBService counter

func (*CustomMetrics) DecMonoVertexMetrics

func (m *CustomMetrics) DecMonoVertexMetrics(name, namespace string)

DecMonoVertexMetrics decrements the MonoVertex counter

func (*CustomMetrics) DecPipelineMetrics

func (m *CustomMetrics) DecPipelineMetrics(name, namespace string)

DecPipelineMetrics decrements the pipeline counter

func (*CustomMetrics) IncISBServiceMetrics

func (m *CustomMetrics) IncISBServiceMetrics(name, namespace string)

IncISBServiceMetrics increments the ISBService counter if it doesn't already know about the ISBService

func (*CustomMetrics) IncMonoVertexMetrics

func (m *CustomMetrics) IncMonoVertexMetrics(name, namespace string)

IncMonoVertexMetrics increments the MonoVertex counter if it doesn't already know about the MonoVertex

func (*CustomMetrics) IncPipelinesRunningMetrics

func (m *CustomMetrics) IncPipelinesRunningMetrics(name, namespace string)

IncPipelinesRunningMetrics increments the pipeline counter if it doesn't already know about the pipeline