open-telemetry/opentelemetry-specification

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

Offen

#1.757 geöffnet am 11.06.2021

Auf GitHub ansehenContributor Guide
 (4 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Makefile (987 Forks)auto 404
Stalehelp wantedspec:logs

Repository-Metriken

Stars
 (4.267 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 10T 15h) (43 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Untersuche den RFC 5424 Abschnitt zur SD ID Benennung, schlage einen konformen Namen vor (z.B. mit '@' Zeichen oder IANA Registrierung) und aktualisiere die Spezifikation entsprechend.
Tech Stack
Keine
Domain
observability
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
RFC 5424 understandingOpenTelemetry logging spec knowledge
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
55