metrics

Documentation

Index

• Constants
• type CtrlFuncMetrics
  • func NewCtrlFuncMetrics() *CtrlFuncMetrics
  • func (c *CtrlFuncMetrics) RecordFallbackCacheGenerationDuration(d time.Duration, err error)
  • func (c *CtrlFuncMetrics) RecordFallbackPushFailure(p Protocol, duration time.Duration, size mo.Option[int], dataplane string, ...)
  • func (c *CtrlFuncMetrics) RecordFallbackPushSuccess(p Protocol, duration time.Duration, size mo.Option[int], dataplane string)
  • func (c *CtrlFuncMetrics) RecordFallbackTranslationBrokenResources(count int)
  • func (c *CtrlFuncMetrics) RecordFallbackTranslationFailure(duration time.Duration)
  • func (c *CtrlFuncMetrics) RecordFallbackTranslationSuccess(duration time.Duration)
  • func (c *CtrlFuncMetrics) RecordProcessedConfigSnapshotCacheHit()
  • func (c *CtrlFuncMetrics) RecordProcessedConfigSnapshotCacheMiss()
  • func (c *CtrlFuncMetrics) RecordPushFailure(p Protocol, d time.Duration, size mo.Option[int], dataplane string, count int, ...)
  • func (c *CtrlFuncMetrics) RecordPushSuccess(p Protocol, d time.Duration, size mo.Option[int], dataplane string)
  • func (c *CtrlFuncMetrics) RecordTranslationBrokenResources(count int)
  • func (c *CtrlFuncMetrics) RecordTranslationFailure(duration time.Duration)
  • func (c *CtrlFuncMetrics) RecordTranslationSuccess(duration time.Duration)
• type Protocol

Constants

const (
	// SuccessTrue indicates that the operation was successful.
	SuccessTrue string = "true"
	// SuccessFalse indicates that the operation was not successful.
	SuccessFalse string = "false"

	// SuccessKey defines the key of the metric label indicating success/failure of an operation.
	SuccessKey string = "success"
)

const (
	// ProtocolDBLess indicates that configuration was sent to Kong using the DB-less protocol (POST /config).
	ProtocolDBLess Protocol = "db-less"
	// ProtocolDeck indicates that configuration was sent to Kong using the DB mode protocol (deck sync).
	ProtocolDeck Protocol = "deck"

	// ProtocolKey defines the key of the metric label indicating which protocol KIC used to configure Kong.
	ProtocolKey string = "protocol"
)

const (
	// FailureReasonConflict indicates that the config push failed due to configuration conflicts.
	FailureReasonConflict string = "conflict"

	// FailureReasonNetwork indicates that the config push failed due to network issues.
	FailureReasonNetwork string = "network"

	// FailureReasonOther indicates that the config push failed due to other reasons.
	FailureReasonOther string = "other"

	// FailureReasonKey defines the key of the metric label indicating failure reason.
	FailureReasonKey string = "failure_reason"
)

const (
	MetricNameConfigPushCount            = "ingress_controller_configuration_push_count"
	MetricNameConfigPushBrokenResources  = "ingress_controller_configuration_push_broken_resource_count"
	MetricNameConfigPushSuccessTime      = "ingress_controller_configuration_push_last_successful"
	MetricNameConfigPushSize             = "ingress_controller_configuration_push_size"
	MetricNameTranslationCount           = "ingress_controller_translation_count"
	MetricNameTranslationBrokenResources = "ingress_controller_translation_broken_resource_count"
	MetricNameTranslationDuration        = "ingress_controller_translation_duration_milliseconds"
	MetricNameConfigPushDuration         = "ingress_controller_configuration_push_duration_milliseconds"
)

Regular config push metrics names.

const (
	MetricNameFallbackTranslationCount           = "ingress_controller_fallback_translation_count"
	MetricNameFallbackTranslationBrokenResources = "ingress_controller_fallback_translation_broken_resource_count"
	MetricNameFallbackTranslationDuration        = "ingress_controller_fallback_translation_duration_milliseconds"
	MetricNameFallbackConfigPushSize             = "ingress_controller_fallback_configuration_push_size"
	MetricNameFallbackConfigPushCount            = "ingress_controller_fallback_configuration_push_count"
	MetricNameFallbackConfigPushSuccessTime      = "ingress_controller_fallback_configuration_push_last"
	MetricNameFallbackConfigPushDuration         = "ingress_controller_fallback_configuration_push_duration_milliseconds"
	MetricNameFallbackConfigPushBrokenResources  = "ingress_controller_fallback_configuration_push_broken_resource_count"
	MetricNameFallbackCacheGenerationDuration    = "ingress_controller_fallback_cache_generation_duration_milliseconds"
	MetricNameProcessedConfigSnapshotCacheHit    = "ingress_controller_processed_config_snapshot_cache_hit"
	MetricNameProcessedConfigSnapshotCacheMiss   = "ingress_controller_processed_config_snapshot_cache_miss"
)

Fallback config push metrics names.

const (
	// DataplaneKey defines the name of the metric label indicating which dataplane this time series is relevant for.
	DataplaneKey string = "dataplane"
)

Types

type CtrlFuncMetrics

type CtrlFuncMetrics struct {
	// Regular config push metrics.
	ConfigPushCount            *prometheus.CounterVec
	ConfigPushBrokenResources  *prometheus.GaugeVec
	TranslationCount           *prometheus.CounterVec
	TranslationBrokenResources prometheus.Gauge
	TranslationDuration        *prometheus.HistogramVec
	ConfigPushDuration         *prometheus.HistogramVec
	ConfigPushSize             *prometheus.GaugeVec
	ConfigPushSuccessTime      *prometheus.GaugeVec

	// Fallback config push metrics.
	FallbackTranslationCount           *prometheus.CounterVec
	FallbackTranslationBrokenResources prometheus.Gauge
	FallbackTranslationDuration        *prometheus.HistogramVec
	FallbackConfigPushCount            *prometheus.CounterVec
	FallbackConfigPushSuccessTime      *prometheus.GaugeVec
	FallbackConfigPushSize             *prometheus.GaugeVec
	FallbackConfigPushBrokenResources  *prometheus.GaugeVec
	FallbackConfigPushDuration         *prometheus.HistogramVec
	FallbackCacheGeneratingDuration    *prometheus.HistogramVec
	ProcessedConfigSnapshotCacheHit    prometheus.Counter
	ProcessedConfigSnapshotCacheMiss   prometheus.Counter
}

func NewCtrlFuncMetrics

func NewCtrlFuncMetrics() *CtrlFuncMetrics

func (*CtrlFuncMetrics) RecordFallbackCacheGenerationDuration

func (c *CtrlFuncMetrics) RecordFallbackCacheGenerationDuration(d time.Duration, err error)

RecordFallbackCacheGenerationDuration records the duration of a fallback cache generation.

func (*CtrlFuncMetrics) RecordFallbackPushFailure

func (c *CtrlFuncMetrics) RecordFallbackPushFailure(
	p Protocol, duration time.Duration, size mo.Option[int], dataplane string, brokenResourcesCount int, err error,
)

RecordFallbackPushFailure records a failed fallback configuration push.

func (*CtrlFuncMetrics) RecordFallbackPushSuccess

func (c *CtrlFuncMetrics) RecordFallbackPushSuccess(
	p Protocol, duration time.Duration, size mo.Option[int], dataplane string,
)

RecordFallbackPushSuccess records a successful fallback configuration push.

func (*CtrlFuncMetrics) RecordFallbackTranslationBrokenResources

func (c *CtrlFuncMetrics) RecordFallbackTranslationBrokenResources(count int)

RecordFallbackTranslationBrokenResources records the number of fallback resources failing translation.

func (*CtrlFuncMetrics) RecordFallbackTranslationFailure

func (c *CtrlFuncMetrics) RecordFallbackTranslationFailure(duration time.Duration)

RecordFallbackTranslationFailure records a failed fallback configuration translation.

func (*CtrlFuncMetrics) RecordFallbackTranslationSuccess

func (c *CtrlFuncMetrics) RecordFallbackTranslationSuccess(duration time.Duration)

RecordFallbackTranslationSuccess records a failed fallback configuration translation.

func (*CtrlFuncMetrics) RecordProcessedConfigSnapshotCacheHit

func (c *CtrlFuncMetrics) RecordProcessedConfigSnapshotCacheHit()

RecordProcessedConfigSnapshotCacheHit records a hit on the processed config snapshot cache.

func (*CtrlFuncMetrics) RecordProcessedConfigSnapshotCacheMiss

func (c *CtrlFuncMetrics) RecordProcessedConfigSnapshotCacheMiss()

RecordProcessedConfigSnapshotCacheMiss records a miss on the processed config snapshot cache.

func (*CtrlFuncMetrics) RecordPushFailure

func (c *CtrlFuncMetrics) RecordPushFailure(p Protocol, d time.Duration, size mo.Option[int], dataplane string, count int, err error)

RecordPushFailure records a failed configuration push.

func (*CtrlFuncMetrics) RecordPushSuccess

func (c *CtrlFuncMetrics) RecordPushSuccess(p Protocol, d time.Duration, size mo.Option[int], dataplane string)

RecordPushSuccess records a successful configuration push.

func (*CtrlFuncMetrics) RecordTranslationBrokenResources

func (c *CtrlFuncMetrics) RecordTranslationBrokenResources(count int)

RecordTranslationBrokenResources records the number of resources failing translation.

func (*CtrlFuncMetrics) RecordTranslationFailure

func (c *CtrlFuncMetrics) RecordTranslationFailure(duration time.Duration)

RecordTranslationFailure records a failed configuration translation.

func (*CtrlFuncMetrics) RecordTranslationSuccess

func (c *CtrlFuncMetrics) RecordTranslationSuccess(duration time.Duration)

RecordTranslationSuccess records a successful configuration translation.

type Protocol

type Protocol string