open-telemetry / opentelemetry-proto

OpenTelemetry protocol (OTLP) specification and Protobuf definitions
https://opentelemetry.io/docs/specs/otlp/
Apache License 2.0
606 stars 263 forks source link

The comment of schema_url doesn't describe it's purpose. #502

Closed MadVikingGod closed 1 year ago

MadVikingGod commented 1 year ago

Six places in the proto define a schema_url, but none of them have a comment describing what should be contained by this string. They only include where it applies to:

// This schema_url applies to all metrics in the "metrics" field.

This has led to confusion by users about what should be used there. https://cloud-native.slack.com/archives/C01NPAXACKT/p1691165635060229?thread_ts=1690392036.272789&cid=C01NPAXACKT

We should include a short description of what the schema_url is.