open-telemetry / semantic-conventions

Defines standards for generating consistent, accessible telemetry across a variety of domains
Apache License 2.0
284 stars 175 forks source link

Add the concept of Blob Reference Properties ("reference attributes" and "reference fields") to the spec #1521

Open michaelsafyan opened 4 weeks ago

michaelsafyan commented 4 weeks ago

Fixes #1428

Changes

Adds the concept of "reference attributes" / "reference fields" to the specification.

Merge requirement checklist

michaelsafyan commented 3 weeks ago

Given the existence of the use of ref in the VCS attributes, I will update this PR with an alternative segment.

michaelsafyan commented 3 weeks ago

Here are some possible naming alternatives to ref:

Any other thoughts? Any opinions on what is best?

michaelsafyan commented 3 weeks ago

I've updated the pull request to use *.blob_ref.* instead of *.ref.* but am open to alternative naming suggestions.

christophe-kamphaus-jemmic commented 3 weeks ago

I think blob_ref is a good choice.

Should there be some tooling to make sure we don't accidentally define anything blob_ref.* in the future? Eg. could we add a policy in policies/ to flag a violation if blob_ref.* is detected?

michaelsafyan commented 1 week ago

Received feedback in Nov 18 SemConv Meeting that this PR needs to be amended to remove "attributes" from the scope, because of the possibility of encouraging large attributes.

Was also suggested to narrow scope to define a specific event type that contains its values as a reference.