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

Consider removing semver: prefix from version or moving to another attribute #802

Closed
anuraaga opened this issue Aug 14, 2020 · 6 comments · Fixed by #873
Closed

Consider removing semver: prefix from version or moving to another attribute #802

anuraaga opened this issue Aug 14, 2020 · 6 comments · Fixed by #873
Labels
area:semantic-conventions Related to semantic conventions priority:p1 Highest priority level release:required-for-ga Must be resolved before GA release, or nice to have before GA spec:resource Related to the specification/resource directory

Comments

@anuraaga
Copy link
Contributor

Currently, we add semver: prefix to versions that are semantic versions. It seems to have come from this comment open-telemetry/oteps#38 (comment).

I have the same question, which I don't see answered in the otep, on what would anyone actually do with the semver prefix in practice. On the flip side, it seems to significantly degrade the UX of using the attribute in systems that don't natively recognize this prefix scheme - I would expect querying for traces with something like version == 1.2.3 to just work. Can we remove the prefix or move the type to a subattribute to allow simple queries to work on versions?

@anuraaga anuraaga added the spec:resource Related to the specification/resource directory label Aug 14, 2020
@Oberon00
Copy link
Member

My impression is that that specification part has been mostly ignored and most have been using unprefixed versions anyway so far. I hope someone can prove me wrong, but if not, I support removing the version prefix spec.

@Oberon00 Oberon00 added the area:semantic-conventions Related to semantic conventions label Aug 14, 2020
@Oberon00
Copy link
Member

what would anyone actually do with the semver prefix in practice

There is a case where this could in theory matter in practice (😉): A hash/commit ID that only has numbers is indistinguishable from a semver version with only the major part displayed (1.0 without traling .0).

@anuraaga
Copy link
Contributor Author

Yeah knowing a value is a git hash could allow linking back to a git repo indeed. At the same time, I think we should let the users define what version scheme they want to use - if 00000000 is the version they want, then regardlessly of if it's git or not I think they should be allowed to search by version == 00000000. So to me removing the prefix seems obvious and if differentiating semver vs gitver vs plain version is important it could be another attribute that backends may use for better linking experience. Bandwidth is probably not a big factor here since version is almost always on the resource which is relatively low bandwidth.

@reyang reyang added priority:p1 Highest priority level release:required-for-ga Must be resolved before GA release, or nice to have before GA labels Aug 14, 2020
@reyang
Copy link
Member

reyang commented Aug 14, 2020

During triage meeting, we need to make a decision whether we want this or not ASAP.

@anuraaga
Copy link
Contributor Author

So, any thoughts? Can I send a PR to remove the version prefix? Let me know what works :)

@carlosalberto
Copy link
Contributor

@anuraaga Please do so (hopefully the changes are not that big). Hopefully that will get the conversation going ;)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:semantic-conventions Related to semantic conventions priority:p1 Highest priority level release:required-for-ga Must be resolved before GA release, or nice to have before GA spec:resource Related to the specification/resource directory
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants