grafana/loki

[Docs] OTEL: Document use of traceID and spanID

Open

#12,098 opened on Feb 29, 2024

View on GitHubContributor guide
 (1 comment) (0 reactions) (1 assignee)Go (3,997 forks)batch import
help wantedopentelemetrytype/docs

Repository metrics

Stars
 (28,187 stars)
PR merge metrics
 (Avg merge 5d 20h) (522 merged PRs in 30d)

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

Research direction
Examine the current OTEL log data model documentation at https://opentelemetry.io/docs/specs/otel/logs/data model/ and identify where traceID and spanID are mentioned. Then locate the Loki documentation for OTEL ingestion and add a section describing how these fields are indexed and searchable.
Tech stack
go
Domain
backenddocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitBasic understanding of OpenTelemetry
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80