From a9fbae53d60b86236b8a9187cd8b35b4109d19b6 Mon Sep 17 00:00:00 2001 From: Antoine Toulme Date: Wed, 31 Jul 2024 23:01:46 -0700 Subject: [PATCH] code review --- config/configtelemetry/doc.go | 31 +++++++++++++++++-------------- 1 file changed, 17 insertions(+), 14 deletions(-) diff --git a/config/configtelemetry/doc.go b/config/configtelemetry/doc.go index 29d572e2409d..d75160f773c6 100644 --- a/config/configtelemetry/doc.go +++ b/config/configtelemetry/doc.go @@ -5,6 +5,10 @@ // 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, the developer is expected to rely on this guidance to +// justify their choice of telemetry level. +// // 1. configtelemetry.None // // No telemetry data should be collected. @@ -13,29 +17,28 @@ // // Signals associated with this level cover the essential coverage of the component telemetry. // -// This is the default level recommended when running the collector. -// -// The signals associated with this level must have low cardinality. +// This is the default level recommended when running the Collector. // -// The signals associated with this level must represent a small data volume: -// - No more than 5 metrics reported. -// - At most 1 span actively recording simultaneously, covering the critical path. -// - At most 5 log records produced every 30s. +// Signals using this telemetry level can use this guidance: +// * The signals associated with this level must show low cardinality, the number of combinations of dimension values. +// * The signals associated with this level must represent a small data volume. Examples follow: +// - A max cardinality (total possible combinations of dimension values) of 50. +// - At most a span actively recording simultaneously, covering the critical path. // -// Not all signals defined in the component telemetry are active. +// * Not all signals defined in the component telemetry are active. // // 3. configtelemetry.Normal // // Signals associated with this level cover the complete coverage of the component telemetry. // -// The signals associated with this level must control cardinality. -// -// The signals associated with this level must represent a controlled data volume: -// - No more than 20 metrics reported. +// Signals 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 max cardinality (total possible combinations of dimension values) of 500. // - At most 5 spans actively recording simultaneously. -// - At most 20 log records produced every 30s. // -// All signals defined in the component telemetry are active. +// * All signals defined in the component telemetry are active. // // 4. configtelemetry.Detailed //