-
Notifications
You must be signed in to change notification settings - Fork 888
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
Remove version convention / semver prefix from versions. #873
Remove version convention / semver prefix from versions. #873
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changelog please! SIGs should be advised to remove any existing version prefixes added by their SDK and instrumentations.
Co-authored-by: Armin Ruech <armin.ruech@dynatrace.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oops, thanks!
The downside of removing this prefix is there is an inability programmatically interpret this version. Similar to how the OCI realized that the original docker hashing scheme was not adequate to fully describe the image hash by itself (you needed to have prior knowledge of the hashing algorithm and hash size used) they developed a This approach allowed for the extensibility of the container hash while remaining fully descriptive of the algorithm. I think it points out a valid approach and one that will help the project in the long term if we try to achieve the same goals here with the version. |
Agreed, but at the same time, the current spec requires instrumentations to know or guess the format of the version. We could add an |
We can still add |
I've never seen so many approvers :) |
…try#873) * Remove version convention / semver prefix from versions. * Moar * api.md * Examples of version strings. * Apply suggestions from code review Co-authored-by: Armin Ruech <armin.ruech@dynatrace.com> * spaec Co-authored-by: Armin Ruech <armin.ruech@dynatrace.com> Co-authored-by: Carlos Alberto Cortez <calberto.cortez@gmail.com> Co-authored-by: Bogdan Drutu <bogdandrutu@gmail.com>
Fixes #802
Changes
Removes the convention of prefixing version numbers with things like
semver:
,git:
. This comes from the idea that the version is the version, adding prefixes makes it something that isn't the version, nor a duck. If a user queries their data for a version number, it is very unintuitive to have to prefix queries withsemver:
, or otherwise every single data store that stores this data needs to natively understand our spec well enough to do this for them which doesn't seem like a worthwhile restriction.I didn't add a separate attribute for the version type - in the issue, no one championed for it. I can add it if it seems very useful. Need to do it now instead of later since then it needs to be
foo.version.id
+foo.version.type
, we can't havefoo.version
+foo.version.type
based on our conventions for attribute key namespaces.