registry.go

Documentation: k8s.io/component-base/metrics/legacyregistry

     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 legacyregistry
    18  
    19  import (
    20  	"net/http"
    21  	"time"
    22  
    23  	"github.com/prometheus/client_golang/prometheus"
    24  	"github.com/prometheus/client_golang/prometheus/collectors"
    25  	"github.com/prometheus/client_golang/prometheus/promhttp"
    26  
    27  	"k8s.io/component-base/metrics"
    28  )
    29  
    30  var (
    31  	defaultRegistry = metrics.NewKubeRegistry()
    32  	// DefaultGatherer exposes the global registry gatherer
    33  	DefaultGatherer metrics.Gatherer = defaultRegistry
    34  	// Reset calls reset on the global registry
    35  	Reset = defaultRegistry.Reset
    36  	// MustRegister registers registerable metrics but uses the global registry.
    37  	MustRegister = defaultRegistry.MustRegister
    38  	// RawMustRegister registers prometheus collectors but uses the global registry, this
    39  	// bypasses the metric stability framework
    40  	//
    41  	// Deprecated
    42  	RawMustRegister = defaultRegistry.RawMustRegister
    43  
    44  	// Register registers a collectable metric but uses the global registry
    45  	Register = defaultRegistry.Register
    46  
    47  	// Registerer exposes the global registerer
    48  	Registerer = defaultRegistry.Registerer
    49  
    50  	processStart time.Time
    51  )
    52  
    53  func init() {
    54  	RawMustRegister(collectors.NewProcessCollector(collectors.ProcessCollectorOpts{}))
    55  	RawMustRegister(collectors.NewGoCollector(collectors.WithGoCollectorRuntimeMetrics(collectors.MetricsAll)))
    56  	defaultRegistry.RegisterMetaMetrics()
    57  	processStart = time.Now()
    58  }
    59  
    60  // Handler returns an HTTP handler for the DefaultGatherer. It is
    61  // already instrumented with InstrumentHandler (using "prometheus" as handler
    62  // name).
    63  func Handler() http.Handler {
    64  	return promhttp.InstrumentMetricHandler(prometheus.DefaultRegisterer, promhttp.HandlerFor(defaultRegistry, promhttp.HandlerOpts{ProcessStartTime: processStart}))
    65  }
    66  
    67  // HandlerWithReset returns an HTTP handler for the DefaultGatherer but invokes
    68  // registry reset if the http method is DELETE.
    69  func HandlerWithReset() http.Handler {
    70  	return promhttp.InstrumentMetricHandler(
    71  		prometheus.DefaultRegisterer,
    72  		metrics.HandlerWithReset(defaultRegistry, metrics.HandlerOpts{ProcessStartTime: processStart}))
    73  }
    74  
    75  // CustomRegister registers a custom collector but uses the global registry.
    76  func CustomRegister(c metrics.StableCollector) error {
    77  	err := defaultRegistry.CustomRegister(c)
    78  
    79  	//TODO(RainbowMango): Maybe we can wrap this error by error wrapping.(Golang 1.13)
    80  	_ = prometheus.Register(c)
    81  
    82  	return err
    83  }
    84  
    85  // CustomMustRegister registers custom collectors but uses the global registry.
    86  func CustomMustRegister(cs ...metrics.StableCollector) {
    87  	defaultRegistry.CustomMustRegister(cs...)
    88  
    89  	for _, c := range cs {
    90  		prometheus.MustRegister(c)
    91  	}
    92  }
    93
View as plain text