search

open-telemetry / opentelemetry-specification

Specifications for OpenTelemetry
https://opentelemetry.io
Apache License 2.0
3.75k stars 890 forks source link

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

Open hauleth opened 3 years ago

hauleth commented 3 years ago

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.

tigrannajaryan commented 3 years ago

I think the action item here is to register "opentelemetry" as an SD-ID with IANA.

hauleth commented 3 years ago

That will probably require creating RFC that will extend RFC 5424.

tigrannajaryan commented 3 years ago

I am guessing there must be a registration process that is different from a full blown RFC: https://www.iana.org/assignments/syslog-parameters/syslog-parameters.xml

We did something similar for OTLP port registration with IANA.

I don't know if we want to go into the trouble though. Seems like a pretty low value feature (I may be wrong). As far as I know the structured data is rarely used with syslog. Most people just cram the attributes into the message.