Skip to content

Commit

Permalink
[configtelemetry] add guidelines for each level of config telemetry
Browse files Browse the repository at this point in the history
  • Loading branch information
atoulme committed Jun 7, 2024
1 parent 0d6e6bf commit f36508e
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 0 deletions.
25 changes: 25 additions & 0 deletions .chloggen/add_guidelines_telemetry.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: enhancement

# The name of the component, or a single word describing the area of concern, (e.g. otlpreceiver)
component: configtelemetry

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Add guidelines for each level of component telemetry

# One or more tracking issues or pull requests related to the change
issues: [10286]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:

# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: []
42 changes: 42 additions & 0 deletions config/configtelemetry/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,46 @@
// Package configtelemetry defines various telemetry level for configuration.
// It enables every component to have access to telemetry level
// to enable metrics only when necessary.
//
// 1. configtelemetry.None
//
// No telemetry data should be collected.
//
// 2. configtelemetry.Basic
//
// 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.
//
// 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.
//
// 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.
// * At most 5 spans actively recording simultaneously.
// * At most 20 log records produced every 30s.
//
// All signals defined in the component telemetry are active.
//
// 4. configtelemetry.Detailed
//
// Signals associated with this level cover the complete coverage of the component telemetry.
//
// The signals associated with this level may exhibit high cardinality.
//
// There is no limit on data volume.
//
// All signals defined in the component telemetry are active.
package configtelemetry // import "go.opentelemetry.io/collector/config/configtelemetry"

0 comments on commit f36508e

Please sign in to comment.