source

Documentation

Index

• Constants
• func WithLogging(cw *ConfigWatcher, cmw configmap.Watcher)
• func WithMetrics(cw *ConfigWatcher, cmw configmap.Watcher)
• func WithTracing(cw *ConfigWatcher, cmw configmap.Watcher)
• type ConfigAccessor
• type ConfigWatcher
  • func WatchConfigurations(loggingCtx context.Context, component string, cmw configmap.Watcher, ...) *ConfigWatcher
  • func (cw *ConfigWatcher) LoggingConfig() *logging.Config
  • func (cw *ConfigWatcher) MetricsConfig() *metrics.ExporterOptions
  • func (cw *ConfigWatcher) ToEnvVars() []corev1.EnvVar
  • func (cw *ConfigWatcher) TracingConfig() *tracingconfig.Config
• type EmptyVarsGenerator
  • func (g *EmptyVarsGenerator) ToEnvVars() []corev1.EnvVar

Constants

const (
	EnvLoggingCfg = "K_LOGGING_CONFIG"
	EnvMetricsCfg = "K_METRICS_CONFIG"
	EnvTracingCfg = "K_TRACING_CONFIG"
)

Functions

func WithLogging

func WithLogging(cw *ConfigWatcher, cmw configmap.Watcher)

WithLogging observes a logging ConfigMap.

func WithMetrics

func WithMetrics(cw *ConfigWatcher, cmw configmap.Watcher)

WithMetrics observes a metrics ConfigMap.

func WithTracing

func WithTracing(cw *ConfigWatcher, cmw configmap.Watcher)

WithTracing observes a tracing ConfigMap.

Types

type ConfigAccessor

type ConfigAccessor interface {
	ToEnvVars() []corev1.EnvVar
	LoggingConfig() *logging.Config
	MetricsConfig() *metrics.ExporterOptions
	TracingConfig() *tracingconfig.Config
}

type ConfigWatcher

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

ConfigWatcher keeps track of logging, metrics and tracing configurations by watching corresponding ConfigMaps.

func WatchConfigurations

func WatchConfigurations(loggingCtx context.Context, component string,
	cmw configmap.Watcher, opts ...configWatcherOption) *ConfigWatcher

WatchConfigurations returns a ConfigWatcher initialized with the given options. If no option is passed, the ConfigWatcher observes ConfigMaps for logging, metrics and tracing.

func (*ConfigWatcher) LoggingConfig

func (cw *ConfigWatcher) LoggingConfig() *logging.Config

LoggingConfig returns the logging configuration from the ConfigWatcher.

func (*ConfigWatcher) MetricsConfig

func (cw *ConfigWatcher) MetricsConfig() *metrics.ExporterOptions

MetricsConfig returns the metrics configuration from the ConfigWatcher.

func (*ConfigWatcher) ToEnvVars

func (cw *ConfigWatcher) ToEnvVars() []corev1.EnvVar

ToEnvVars serializes the contents of the ConfigWatcher to individual environment variables.

func (*ConfigWatcher) TracingConfig

func (cw *ConfigWatcher) TracingConfig() *tracingconfig.Config

TracingConfig returns the tracing configuration from the ConfigWatcher.

type EmptyVarsGenerator

type EmptyVarsGenerator struct {
	ConfigAccessor
}

EmptyVarsGenerator generates empty env vars. Intended to be used in tests.

func (*EmptyVarsGenerator) ToEnvVars

func (g *EmptyVarsGenerator) ToEnvVars() []corev1.EnvVar