grafana/loki

[Docs] OTEL: Document use of traceID and spanID

Open

#12,098 opened on Feb 29, 2024

View on GitHub
 (0 comments) (0 reactions) (1 assignee)Go (28,187 stars) (3,997 forks)batch import
help wantedopentelemetrytype/docs

Description

From an e-mail:

The documentation lacks statements about indexing or search capabilities based on traceID and spanID:

https://opentelemetry.io/docs/specs/otel/logs/data-model/

Those are core metadata and they do not act like attribute. Hence, they require special treatment and documentation of that.

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
OpenTelemetry logging conceptsMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the OpenTelemetry logs data model documentation at https://opentelemetry.io/docs/specs/otel/logs/data model/ to understand the current coverage of traceID and spanID. Check Loki's documentation for how trace context is used in log entries. Propose additions to the Loki documentation describing how traceID and spanID can be indexed or searched.
[Docs] OTEL: Document use of traceID and spanID · grafana/loki#12098 | Good First Issue