metrics

Documentation

Index

• Constants
• Variables
• func DumpMetrics() ([]*models.Metric, error)
• type Config
  • func (def Config) Flags(flags *pflag.FlagSet)
• type RegisterGatherer
• type SharedConfig

Constants

const (
	// OperatorPrometheusServeAddr IP:Port on which to serve prometheus metrics
	// (pass ":<port>" to bind on all interfaces).
	OperatorPrometheusServeAddr = "operator-prometheus-serve-addr"
)

Variables

var Cell = cell.Module(
	"operator-metrics",
	"Operator Metrics",

	cell.Config(defaultConfig),
	cell.Invoke(registerMetricsManager),
)

Cell provides the modular metrics registry, metric HTTP server and legacy metrics cell for the operator.

Functions

func DumpMetrics

func DumpMetrics() ([]*models.Metric, error)

DumpMetrics gets the current Cilium operator metrics and dumps all into a Metrics structure. If metrics cannot be retrieved, returns an error.

Types

type Config

type Config struct {
	OperatorPrometheusServeAddr string
}

Config contains the configuration for the operator-metrics cell.

func (Config) Flags

func (def Config) Flags(flags *pflag.FlagSet)

type RegisterGatherer

type RegisterGatherer interface {
	prometheus.Registerer
	prometheus.Gatherer
}

var Registry RegisterGatherer

Registry is the global prometheus registry for cilium-operator metrics.

type SharedConfig

type SharedConfig struct {
	// EnableMetrics is set to true if operator metrics are enabled
	EnableMetrics bool

	// EnableGatewayAPI enables support of Gateway API
	EnableGatewayAPI bool
}

SharedConfig contains the configuration that is shared between this module and others. Metrics cell needs to know if GatewayAPI is enabled in order to use the same Registry as controller-runtime and avoid to expose multiple metrics endpoints or servers.