open-telemetry/opentelemetry-specification

`opentelemetry` SD-ID proposed in syslog format is not allowed by RFC 5424

Open

#1,757 opened on Jun 11, 2021

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Makefile (987 forks)auto 404
help wantedspec:logs

Repository metrics

Stars
 (4,267 stars)
PR merge metrics
 (PR metrics pending)

Description

I am reviewing Logger specs as a preparation in implementing it in Erlang implementation and I have spotted that specs suggests using opentelemetry SD-ID when working with "legacy syslog" format.

Trace id, span id and traceflags SHOULD be recorded via SD-ID "opentelemetry".

This directly collides with the RFC 5424 Section 6.3.2. that states that all names not containing at sign (@) are reserved for IANA and should not be used unless registered. AFAIK we haven't registered such SD-ID in IANA yet.

Contributor guide

Research direction
Investigate the RFC 5424 section on SD ID naming, propose a compliant name (e.g., with '@' sign or IANA registration), and update the specification accordingly.
Tech stack
None
Domain
observability
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.
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
RFC 5424 understandingOpenTelemetry logging spec knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55