metrics.go

Documentation: k8s.io/kubernetes/pkg/kubelet/server/metrics

     1  /*
     2  Copyright 2019 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 metrics
    18  
    19  import (
    20  	"sync"
    21  	"time"
    22  
    23  	"k8s.io/component-base/metrics"
    24  	"k8s.io/component-base/metrics/legacyregistry"
    25  )
    26  
    27  const (
    28  	kubeletSubsystem = "kubelet"
    29  )
    30  
    31  var (
    32  	// HTTPRequests tracks the number of the http requests received since the server started.
    33  	HTTPRequests = metrics.NewCounterVec(
    34  		&metrics.CounterOpts{
    35  			Subsystem:      kubeletSubsystem,
    36  			Name:           "http_requests_total",
    37  			Help:           "Number of the http requests received since the server started",
    38  			StabilityLevel: metrics.ALPHA,
    39  		},
    40  		// server_type aims to differentiate the readonly server and the readwrite server.
    41  		// long_running marks whether the request is long-running or not.
    42  		// Currently, long-running requests include exec/attach/portforward/debug.
    43  		[]string{"method", "path", "server_type", "long_running"},
    44  	)
    45  	// HTTPRequestsDuration tracks the duration in seconds to serve http requests.
    46  	HTTPRequestsDuration = metrics.NewHistogramVec(
    47  		&metrics.HistogramOpts{
    48  			Subsystem: kubeletSubsystem,
    49  			Name:      "http_requests_duration_seconds",
    50  			Help:      "Duration in seconds to serve http requests",
    51  			// Use DefBuckets for now, will customize the buckets if necessary.
    52  			Buckets:        metrics.DefBuckets,
    53  			StabilityLevel: metrics.ALPHA,
    54  		},
    55  		[]string{"method", "path", "server_type", "long_running"},
    56  	)
    57  	// HTTPInflightRequests tracks the number of the inflight http requests.
    58  	HTTPInflightRequests = metrics.NewGaugeVec(
    59  		&metrics.GaugeOpts{
    60  			Subsystem:      kubeletSubsystem,
    61  			Name:           "http_inflight_requests",
    62  			Help:           "Number of the inflight http requests",
    63  			StabilityLevel: metrics.ALPHA,
    64  		},
    65  		[]string{"method", "path", "server_type", "long_running"},
    66  	)
    67  	// VolumeStatCalDuration tracks the duration in seconds to calculate volume stats.
    68  	// this metric is mainly for comparison between fsquota monitoring and `du` for disk usage.
    69  	VolumeStatCalDuration = metrics.NewHistogramVec(
    70  		&metrics.HistogramOpts{
    71  			Subsystem:      kubeletSubsystem,
    72  			Name:           "volume_metric_collection_duration_seconds",
    73  			Help:           "Duration in seconds to calculate volume stats",
    74  			Buckets:        metrics.DefBuckets,
    75  			StabilityLevel: metrics.ALPHA,
    76  		},
    77  		[]string{"metric_source"},
    78  	)
    79  )
    80  
    81  var registerMetrics sync.Once
    82  
    83  // Register all metrics.
    84  func Register() {
    85  	registerMetrics.Do(func() {
    86  		legacyregistry.MustRegister(HTTPRequests)
    87  		legacyregistry.MustRegister(HTTPRequestsDuration)
    88  		legacyregistry.MustRegister(HTTPInflightRequests)
    89  		legacyregistry.MustRegister(VolumeStatCalDuration)
    90  	})
    91  }
    92  
    93  // SinceInSeconds gets the time since the specified start in seconds.
    94  func SinceInSeconds(start time.Time) float64 {
    95  	return time.Since(start).Seconds()
    96  }
    97  
    98  // CollectVolumeStatCalDuration collects the duration in seconds to calculate volume stats.
    99  func CollectVolumeStatCalDuration(metricSource string, start time.Time) {
   100  	VolumeStatCalDuration.WithLabelValues(metricSource).Observe(SinceInSeconds(start))
   101  }
   102
View as plain text