metrics.go

Documentation: k8s.io/component-base/metrics/prometheus/slis

     1  /*
     2  Copyright 2022 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package slis
    18  
    19  import (
    20  	"context"
    21  	k8smetrics "k8s.io/component-base/metrics"
    22  )
    23  
    24  type HealthcheckStatus string
    25  
    26  const (
    27  	Success HealthcheckStatus = "success"
    28  	Error   HealthcheckStatus = "error"
    29  )
    30  
    31  var (
    32  	// healthcheck is a Prometheus Gauge metrics used for recording the results of a k8s healthcheck.
    33  	healthcheck = k8smetrics.NewGaugeVec(
    34  		&k8smetrics.GaugeOpts{
    35  			Namespace:      "kubernetes",
    36  			Name:           "healthcheck",
    37  			Help:           "This metric records the result of a single healthcheck.",
    38  			StabilityLevel: k8smetrics.STABLE,
    39  		},
    40  		[]string{"name", "type"},
    41  	)
    42  
    43  	// healthchecksTotal is a Prometheus Counter metrics used for counting the results of a k8s healthcheck.
    44  	healthchecksTotal = k8smetrics.NewCounterVec(
    45  		&k8smetrics.CounterOpts{
    46  			Namespace:      "kubernetes",
    47  			Name:           "healthchecks_total",
    48  			Help:           "This metric records the results of all healthcheck.",
    49  			StabilityLevel: k8smetrics.STABLE,
    50  		},
    51  		[]string{"name", "type", "status"},
    52  	)
    53  )
    54  
    55  func Register(registry k8smetrics.KubeRegistry) {
    56  	registry.Register(healthcheck)
    57  	registry.Register(healthchecksTotal)
    58  	_ = k8smetrics.RegisterProcessStartTime(registry.Register)
    59  }
    60  
    61  func ResetHealthMetrics() {
    62  	healthcheck.Reset()
    63  	healthchecksTotal.Reset()
    64  }
    65  
    66  func ObserveHealthcheck(ctx context.Context, name string, healthcheckType string, status HealthcheckStatus) error {
    67  	if status == Success {
    68  		healthcheck.WithContext(ctx).WithLabelValues(name, healthcheckType).Set(1)
    69  	} else {
    70  		healthcheck.WithContext(ctx).WithLabelValues(name, healthcheckType).Set(0)
    71  	}
    72  
    73  	healthchecksTotal.WithContext(ctx).WithLabelValues(name, healthcheckType, string(status)).Inc()
    74  	return nil
    75  }
    76
View as plain text