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 telemetry generated by the core Collector API. Components outside of the core API MUST NOT record telemetry at this level.
3. configtelemetry.Normal
Telemetry associated with this level provides intermediate coverage of the Collector telemetry. It should be the default for component authors.
Normal-level telemetry should have limited cardinality and data volume, though it is acceptable for them to scale linearly with the monitored resources. For example, there may be a limit of 5 attribute sets or 5 spans generated per request.
Normal-level telemetry should also have a low computational cost: it should not contain values requiring significant additional computation compared to the normal flow of processing.
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, high data volume, or high computational cost.
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 should be collected. LevelNone Level = iota - 1 // LevelBasic indicates that only core Collector telemetry should be collected. LevelBasic // LevelNormal indicates that all low-overhead telemetry should be collected. LevelNormal // LevelDetailed indicates that all available telemetry should be collected. LevelDetailed )
func (Level) MarshalText ¶
MarshalText marshals Level to text.
func (*Level) UnmarshalText ¶
UnmarshalText unmarshalls text to a Level.
Source Files