Version: v0.24.2 Latest Latest

This package is not in the latest version of its module.

Go to latest
Published: Jun 17, 2022 License: Apache-2.0 Imports: 4 Imported by: 205



Package metrics provides abstractions for registering which metrics to record.



This section is empty.


View Source
var (
	// ClientCertExpiry is the expiry time of a client certificate
	ClientCertExpiry ExpiryMetric = noopExpiry{}
	// ClientCertRotationAge is the age of a certificate that has just been rotated.
	ClientCertRotationAge DurationMetric = noopDuration{}
	// RequestLatency is the latency metric that rest clients will update.
	RequestLatency LatencyMetric = noopLatency{}
	// RequestSize is the request size metric that rest clients will update.
	RequestSize SizeMetric = noopSize{}
	// ResponseSize is the response size metric that rest clients will update.
	ResponseSize SizeMetric = noopSize{}
	// RateLimiterLatency is the client side rate limiter latency metric.
	RateLimiterLatency LatencyMetric = noopLatency{}
	// RequestResult is the result metric that rest clients will update.
	RequestResult ResultMetric = noopResult{}
	// ExecPluginCalls is the number of calls made to an exec plugin, partitioned by
	// exit code and call status.
	ExecPluginCalls CallsMetric = noopCalls{}


func Register

func Register(opts RegisterOpts)

Register registers metrics for the rest client to use. This can only be called once.


type CallsMetric added in v0.21.0

type CallsMetric interface {
	// Increment increments a counter per exitCode and callStatus.
	Increment(exitCode int, callStatus string)

CallsMetric counts calls that take place for a specific exec plugin.

type DurationMetric added in v0.18.0

type DurationMetric interface {
	Observe(duration time.Duration)

DurationMetric is a measurement of some amount of time.

type ExpiryMetric added in v0.18.0

type ExpiryMetric interface {
	Set(expiry *time.Time)

ExpiryMetric sets some time of expiry. If nil, assume not relevant.

type LatencyMetric

type LatencyMetric interface {
	Observe(ctx context.Context, verb string, u url.URL, latency time.Duration)

LatencyMetric observes client latency partitioned by verb and url.

type RegisterOpts added in v0.18.0

type RegisterOpts struct {
	ClientCertExpiry      ExpiryMetric
	ClientCertRotationAge DurationMetric
	RequestLatency        LatencyMetric
	RequestSize           SizeMetric
	ResponseSize          SizeMetric
	RateLimiterLatency    LatencyMetric
	RequestResult         ResultMetric
	ExecPluginCalls       CallsMetric

RegisterOpts contains all the metrics to register. Metrics may be nil.

type ResultMetric

type ResultMetric interface {
	Increment(ctx context.Context, code string, method string, host string)

ResultMetric counts response codes partitioned by method and host.

type SizeMetric added in v0.24.0

type SizeMetric interface {
	Observe(ctx context.Context, verb string, host string, size float64)

SizeMetric observes client response size partitioned by verb and host.

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL