configtelemetry

Documentation

Overview

Package configtelemetry defines various telemetry level for configuration. It enables every component to have access to telemetry level to enable metrics only when necessary.

Index

• Constants
• func Flags(flags *flag.FlagSet)
• func GetMetricsAddr() string
• func GetMetricsAddrDefault() string
• type Level
  • func GetMetricsLevelFlagValue() Level
  • func (l *Level) Set(s string) error
  • func (l Level) String() string
  • func (l *Level) UnmarshalText(text []byte) error

Constants

const UseOpenTelemetryForInternalMetrics = false

Functions

func Flags

func Flags(flags *flag.FlagSet)

Flags is a helper function to add telemetry config flags to the service that exposes the application flags.

func GetMetricsAddr

func GetMetricsAddr() string

Deprecated: This function will be removed in the future.

func GetMetricsAddrDefault

func GetMetricsAddrDefault() string

GetMetricsAddrDefault returns the default metrics bind address and port depending on the current build type. Deprecated: This function will be removed in the future.

Types

type Level

type Level int32

Level is the level of internal telemetry (metrics, logs, traces about the component itself) that every component should generate.

const (
	// LevelNone indicates that no telemetry data should be collected.
	LevelNone Level = iota - 1
	// LevelBasic is the recommended and covers the basics of the service telemetry.
	LevelBasic
	// LevelNormal adds some other indicators on top of basic.
	LevelNormal
	// LevelDetailed adds dimensions and views to the previous levels.
	LevelDetailed
)

func GetMetricsLevelFlagValue

func GetMetricsLevelFlagValue() Level

GetMetricsLevelFlagValue returns the value of the "--metrics-level" flag. IMPORTANT: This must be used only in the core collector code for the moment. Deprecated: This function will be removed in the future.

func (*Level) Set

func (l *Level) Set(s string) error

Set sets the telemetry level.

func (Level) String

func (l Level) String() string

func (*Level) UnmarshalText

func (l *Level) UnmarshalText(text []byte) error

UnmarshalText unmarshals text to a Level.