configtelemetry

package module
v0.119.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 4, 2025 License: Apache-2.0 Imports: 3 Imported by: 50

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.

This document provides guidance on which telemetry level to adopt for Collector metrics. When adopting a telemetry level, component authors are expected to rely on this guidance to justify their choice of telemetry level.

1. configtelemetry.None

No telemetry data is recorded.

2. configtelemetry.Basic

Telemetry associated with this level provides essential coverage of the collector telemetry. It should only be used for internal collector telemetry generated by the collector core API. Components outside of the core API MUST NOT record additional telemetry at this level.

3. configtelemetry.Normal

Telemetry associated with this level provides complete coverage of the collector telemetry. It should be the default for component authors.

Component authors using this telemetry level can use this guidance:

  • The signals associated with this level must control cardinality. It is acceptable at this level for cardinality to scale linearly with the monitored resources.

  • The signals associated with this level must represent a controlled data volume. Examples follow:

    a. A max cardinality (total possible combinations of dimension values) for a given metric of at most 100.

    b. At most 5 spans actively recording simultaneously per active request.

This is the default level recommended when running the Collector.

4. configtelemetry.Detailed

Telemetry associated with this level provides complete coverage of the collector telemetry.

The signals associated with this level may exhibit high cardinality and/or high dimensionality.

There is no limit on data volume.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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 (Level) MarshalText

func (l Level) MarshalText() (text []byte, err error)

MarshalText marshals Level to text.

func (Level) String

func (l Level) String() string

func (*Level) UnmarshalText

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

UnmarshalText unmarshalls text to a Level.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL