package
0.33.0-alpha.2
Repository: https://github.com/kubernetes/component-base.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

BuildFQName joins the given three name components by "_".
No description provided by the author
ExponentialBuckets is a wrapper for prometheus.ExponentialBuckets.
ExponentialBucketsRange creates 'count' buckets, where the lowest bucket is 'min' and the highest bucket is 'max'.
No description provided by the author
HandlerFor returns an uninstrumented http.Handler for the provided Gatherer.
HandlerWithReset return an http.Handler with Reset.
LinearBuckets is a wrapper for prometheus.LinearBuckets.
MergeBuckets merges buckets together.
NewConstMetric is a helper of NewConstMetric.
NewCounter returns an object which satisfies the kubeCollector and CounterMetric interfaces.
NewCounterVec returns an object which satisfies the kubeCollector and (almost) CounterVecMetric interfaces.
NewDesc extends prometheus.NewDesc with stability support.
NewGauge returns an object which satisfies the kubeCollector, Registerable, and Gauge interfaces.
NewGaugeFunc creates a new GaugeFunc based on the provided GaugeOpts.
NewGaugeVec returns an object which satisfies the kubeCollector, Registerable, and GaugeVecMetric interfaces.
NewHistogram returns an object which is Histogram-like.
No description provided by the author
NewKubeRegistry creates a new vanilla Registry.
NewLazyConstMetric is a helper of MustNewConstMetric.
NewLazyMetricWithTimestamp is a helper of NewMetricWithTimestamp.
NewOptions returns default metrics options.
NewSummary returns an object which is Summary-like.
NewSummaryVec returns an object which satisfies kubeCollector and wraps the prometheus.SummaryVec object.
NewTestableTimingHistogram adds injection of the clock.
NewTestableTimingHistogramVec adds injection of the clock.
NewTimingHistogram returns an object which is TimingHistogram-like.
NewTimingHistogramVec returns an object which satisfies the kubeCollector, Registerable, and GaugeVecMetric interfaces and wraps an underlying promext.TimingHistogramVec object.
RegisterBuildInfo registers the build and version info in a metadata metric in prometheus.
RegisterProcessStartTime registers the process_start_time_seconds to a prometheus registry.
ResetLabelValueAllowLists resets the allow lists for label values.
No description provided by the author
No description provided by the author
No description provided by the author
SetShowHidden will enable showing hidden metrics.
ShouldShowHidden returns whether showing hidden deprecated metrics is enabled.
ValidateShowHiddenMetricsVersion checks invalid version for which show hidden metrics.

# Constants

ALPHA metrics have no stability guarantees, as such, labels may be arbitrarily added/removed and the metric may be deleted at any time.
BETA metrics are governed by the deprecation policy outlined in by the control plane metrics stability KEP.
ContinueOnError ignore errors and try to serve as many metrics as possible.
Possible values for the ValueType enum.
No description provided by the author
No description provided by the author
No description provided by the author
Possible values for the ValueType enum.
HTTPErrorOnError serve an HTTP status code 500 upon the first error encountered.
INTERNAL metrics have no stability guarantees, as such, labels may be arbitrarily added/removed and the metric may be deleted at any time.
PanicOnError panics upon the first error encountered (useful for "crash only" apps).
STABLE metrics are guaranteed not be mutated and removal is governed by the deprecation policy outlined in by the control plane metrics stability KEP.
Possible values for the ValueType enum.

# Variables

BuildVersion is a helper function that can be easily mocked.
DefBuckets is a wrapper for prometheus.DefBuckets.

# Structs

BaseStableCollector which implements almost all methods defined by StableCollector is a convenient assistant for custom collectors.
Counter is our internal representation for our wrapping struct around prometheus counters.
CounterVec is the internal representation of our wrapping struct around prometheus counterVecs.
CounterVecWithContext is the wrapper of CounterVec with context.
Desc is a prometheus.Desc extension.
Gauge is our internal representation for our wrapping struct around prometheus gauges.
GaugeVec is the internal representation of our wrapping struct around prometheus gaugeVecs.
GaugeVecWithContext is the wrapper of GaugeVec with context.
Histogram is our internal representation for our wrapping struct around prometheus histograms.
HistogramOpts bundles the options for creating a Histogram metric.
HistogramVec is the internal representation of our wrapping struct around prometheus histogramVecs.
HistogramVecWithContext is the wrapper of HistogramVec with context.
KubeOpts is superset struct for prometheus.Opts.
No description provided by the author
Options has all parameters needed for exposing metrics from components.
Summary is our internal representation for our wrapping struct around prometheus summaries.
SummaryOpts bundles the options for creating a Summary metric.
SummaryVec is the internal representation of our wrapping struct around prometheus summaryVecs.
SummaryVecWithContext is the wrapper of SummaryVec with context.
TimingHistogram is our internal representation for our wrapping struct around timing histograms.
TimingHistogramOpts bundles the options for creating a TimingHistogram metric.
TimingHistogramVec is the internal representation of our wrapping struct around prometheus TimingHistogramVecs.
TimingHistogramVecWithContext is the wrapper of TimingHistogramVec with context.

# Interfaces

Collector defines a subset of prometheus.Collector interface methods.
CounterMetric is an interface which defines a subset of the interface provided by prometheus.Counter.
CounterVecMetric is an interface which prometheus.CounterVec satisfies.
Gatherer is the interface for the part of a registry in charge of gathering the collected metrics into a number of MetricFamilies.
GaugeFunc is a Gauge whose value is determined at collect time by calling a provided function.
GaugeMetric is an interface which defines a subset of the interface provided by prometheus.Gauge.
GaugeVecMetric is a collection of Gauges that differ only in label values.
KubeRegistry is an interface which implements a subset of prometheus.Registerer and prometheus.Gatherer interfaces.
Metric defines a subset of prometheus.Metric interface methods.
ObserverMetric captures individual observations.
PrometheusTimingHistogram is the abstraction of the underlying histogram that we want to promote from the wrapper.
PromRegistry is an interface which implements a subset of prometheus.Registerer and prometheus.Gatherer interfaces.
Registerable is an interface for a collector metric which we will register with KubeRegistry.
Registerer is the interface for the part of a registry in charge of registering the collected metrics.
StableCollector extends the prometheus.Collector interface to allow customization of the metric registration process, it's especially intend to be used in scenario of custom collector.

# Type aliases

CounterOpts is an alias for Opts.
GaugeOpts is an alias for Opts.
HandlerOpts specifies options how to serve metrics via an http.Handler.
Labels represents a collection of label name -> value mappings.
StabilityLevel represents the API guarantees for a given defined metric.
ValueType is an enumeration of metric types that represent a simple value.