metrics

Documentation

Index

• Constants
• Variables
• type ClientConnectionStatus
• type ClientMetrics
  • func (c *ClientMetrics) GetClientConnectionsMetric() *prometheus.GaugeVec
  • func (c *ClientMetrics) LegacyRegisterMetrics(mustRegisterFn func(...prometheus.Collector))
  • func (c *ClientMetrics) ObserveDialFailure(reason DialFailureReason)
  • func (c *ClientMetrics) ObservePacket(segment commonmetrics.Segment, packetType client.PacketType)
  • func (c *ClientMetrics) ObserveStreamError(segment commonmetrics.Segment, err error, packetType client.PacketType)
  • func (c *ClientMetrics) ObserveStreamErrorNoPacket(segment commonmetrics.Segment, err error)
  • func (c *ClientMetrics) RegisterMetrics(r prometheus.Registerer)
  • func (c *ClientMetrics) Reset()
• type DialFailureReason

Constants

const (
	Namespace = "konnectivity_network_proxy"
	Subsystem = "client"
)

Variables

var (
	// Metrics provides access to all client metrics. The client
	// application is responsible for registering (via Metrics.RegisterMetrics).
	Metrics = newMetrics()
)

Types

type ClientConnectionStatus

type ClientConnectionStatus string

const (
	// The connection is created but has not yet been dialed.
	ClientConnectionStatusCreated ClientConnectionStatus = "created"
	// The connection is pending dial response.
	ClientConnectionStatusDialing ClientConnectionStatus = "dialing"
	// The connection is established.
	ClientConnectionStatusOk ClientConnectionStatus = "ok"
	// The connection is closing.
	ClientConnectionStatusClosing ClientConnectionStatus = "closing"
)

type ClientMetrics

type ClientMetrics struct {
	// contains filtered or unexported fields
}

ClientMetrics includes all the metrics of the konnectivity-client.

func (*ClientMetrics) GetClientConnectionsMetric

func (c *ClientMetrics) GetClientConnectionsMetric() *prometheus.GaugeVec

func (*ClientMetrics) LegacyRegisterMetrics

func (c *ClientMetrics) LegacyRegisterMetrics(mustRegisterFn func(...prometheus.Collector))

LegacyRegisterMetrics registers all metrics via MustRegister func. TODO: remove this once https://github.com/kubernetes/kubernetes/pull/114293 is available.

func (*ClientMetrics) ObserveDialFailure

func (c *ClientMetrics) ObserveDialFailure(reason DialFailureReason)

func (*ClientMetrics) ObservePacket

func (c *ClientMetrics) ObservePacket(segment commonmetrics.Segment, packetType client.PacketType)

func (*ClientMetrics) ObserveStreamError

func (c *ClientMetrics) ObserveStreamError(segment commonmetrics.Segment, err error, packetType client.PacketType)

func (*ClientMetrics) ObserveStreamErrorNoPacket

func (c *ClientMetrics) ObserveStreamErrorNoPacket(segment commonmetrics.Segment, err error)

func (*ClientMetrics) RegisterMetrics

func (c *ClientMetrics) RegisterMetrics(r prometheus.Registerer)

RegisterMetrics registers all metrics with the client application.

func (*ClientMetrics) Reset

func (c *ClientMetrics) Reset()

Reset resets the metrics.

type DialFailureReason

type DialFailureReason string

const (
	DialFailureUnknown DialFailureReason = "unknown"
	// DialFailureTimeout indicates the hard 30 second timeout was hit.
	DialFailureTimeout DialFailureReason = "timeout"
	// DialFailureContext indicates that the context was cancelled or reached it's deadline before
	// the dial response was returned.
	DialFailureContext DialFailureReason = "context"
	// DialFailureEndpoint indicates that the konnectivity-agent was unable to reach the backend endpoint.
	DialFailureEndpoint DialFailureReason = "endpoint"
	// DialFailureDialClosed indicates that the client received a CloseDial response, indicating the
	// connection was closed before the dial could complete.
	DialFailureDialClosed DialFailureReason = "dialclosed"
	// DialFailureTunnelClosed indicates that the client connection was closed before the dial could
	// complete.
	DialFailureTunnelClosed DialFailureReason = "tunnelclosed"
)