Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unify Attributes and Labels #1069

Closed
MrAlias opened this issue Aug 18, 2020 · 6 comments · Fixed by #1541
Closed

Unify Attributes and Labels #1069

MrAlias opened this issue Aug 18, 2020 · 6 comments · Fixed by #1541
Assignees
Labels
question Further information is requested
Milestone

Comments

@MrAlias
Copy link
Contributor

MrAlias commented Aug 18, 2020

Currently Attributes in the tracing portion of this code is synonymous with label.KeyValue. This duplicate naming (attribute and label) will lead to confusion for new (and likely existing) users. This duplication comes from the specification itself unfortunately. Attributes are used in the tracing and resource specification (and have been unified in the "common" part of the specification) and labels are used in the metric specification. There was a previous attempt to resolve this difference in the specification, but it did not produce a resolution.

Can we do better in this repository?

@seh
Copy link
Contributor

seh commented Aug 18, 2020

Since we are not afraid of renaming packages and moving types, have we considered a package name like "attr"?

@MrAlias
Copy link
Contributor Author

MrAlias commented Aug 20, 2020

My hope was to unify on the term label as it is a complete word and shorter than attribute.

It is important that this work does not impact the compatibility of the project. That means that the Spant field will likely need to remain being named Attributes. This might also apply to the Resource, but since it is only used in the internal SDK, that might not be as strong a requirement.

@MrAlias MrAlias added this to the RC1 milestone Aug 27, 2020
@MrAlias
Copy link
Contributor Author

MrAlias commented Oct 8, 2020

open-telemetry/opentelemetry-specification#948

This is likely going to be the top issue at the next Specification SIG meeting.

@MrAlias
Copy link
Contributor Author

MrAlias commented Nov 9, 2020

Specification issue is being tracked here now: open-telemetry/opentelemetry-specification#1113

@MrAlias
Copy link
Contributor Author

MrAlias commented Nov 13, 2020

Given the label package is already used for attributes, we should not be blocked with issues blocking open-telemetry/opentelemetry-specification#1113 and should be able rename the label package and metric use of it.

@MrAlias MrAlias modified the milestone: RC1 Feb 12, 2021
@MrAlias
Copy link
Contributor Author

MrAlias commented Feb 16, 2021

Let's rename the label package to attr.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants