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.

Sign up for GitHub

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

Jump to bottom

Define versioning and support for OpenTelemetry #1267

Closed
tedsuo opened this issue Nov 30, 2020 · 3 comments
Closed

Define versioning and support for OpenTelemetry #1267

tedsuo opened this issue Nov 30, 2020 · 3 comments
Assignees
@tedsuo
Labels
priority:p1 Highest priority level release:required-for-ga Must be resolved before GA release, or nice to have before GA spec:miscellaneous For issues that don't match any other spec label

Comments

@tedsuo
Copy link
Contributor

tedsuo commented Nov 30, 2020 •
edited by Oberon00
Loading

The trace specification frozen, we are rapidly approaching the stable release of tracing for OpenTelemetry. Due to the project's size and scope, versioning and support are tricky issues. We need to define these concepts in concrete terms before we can declare tracing to be stable.

  • How do we define version numbers?
  • How do we define releases?
  • How do we define API, SDK, conventions, and contrib support?
  • How do we define ongoing experimental and beta work after some packages become stable?

A WIP proposal is open for comment here: https://docs.google.com/document/d/1QHlPsMqwrBm7-IIPef9czuM8KFiLbEDMzGhPrmHcppA/edit#

Alternate proposals are also acceptable, but we are trying to move quickly. By Friday, this WIP will be submitted as an OTEP, with the goal of finding approval by Friday, December 11th. Please contribute this week! Package management and backwards compatibility can have language-specific requirements, so we need maintainers to review this and determine that this proposal it will work for their implementation.

Thank you,
@tedsuo
@tedsuo tedsuo added the spec:miscellaneous For issues that don't match any other spec label label Nov 30, 2020
@carlosalberto carlosalberto added priority:p1 Highest priority level release:required-for-ga Must be resolved before GA release, or nice to have before GA labels Dec 1, 2020
@tedsuo
Copy link
Contributor Author

tedsuo commented Dec 7, 2020 •
edited
Loading

OTEP has been released here: open-telemetry/oteps#143

Request for SIG maintainers: please create a language-specific document which describes how versioning and support works for your language, based on this OTEP, and post a link to it here. We want to ensure that versioning and support as been thought through before it is added to the spec.

What is in a language specific draft? Ultimately, it represents what you want to have posted in your repo, as a further clarification of the versioning guarantees and change process described in the OTEP. But for now, the goal is to ensure that maintainers understand how they are going to meet versioning and support guarantees as they continue to work on the project.

The request is to have the following information posted here on Wednesday:

A versioning exercise:
Write out a timeline for the following actions:

  • Release tracing as stable, but keep metrics as experimental.
  • Release metrics as stable.
    List out the actions you would take, including versions, releases, movement of packages, etc. Include descriptions of the API, SDK, and example contrib package as part of this exercise.

Please check out language specific-examples in the original draft for inspiration.

Write up a draft which explains language specific versioning details:

  • How are packages marked as stable vs experimental? How is this communicated to the user?
  • How should the repo be tagged? Rules about organizing code within the repo?
  • Are there any language-specific versioning rules or conventions which must be addressed?
  • How should artifacts be managed? Releases, package managers, etc.
  • How are stability guarantees verified?

@tedsuo tedsuo mentioned this issue Dec 7, 2020
Merged
@jkwatson jkwatson mentioned this issue Dec 7, 2020
Closed
@tedsuo
Copy link
Contributor Author

tedsuo commented Dec 8, 2020

Cat herding champions, who will work with maintainers to create language specific versioning documents, based on the maintainer's meeting on Monday:

Java - JWatson
JS - Daniel
Go - Tyler, JBD & Alolita
Python - Alolita
Erlang - Tristan
C# .NET - Alolita & Carlos
Ruby - Matt W. & Daniel
Rust - Julian & Daniel
PHP - Bob & Daniel
C++ - Alolita & Lalit
Collector - Tigran

@codeboten codeboten mentioned this issue Dec 8, 2020
Closed
@dyladan dyladan mentioned this issue Dec 9, 2020
Merged
@tsloughter tsloughter mentioned this issue Dec 9, 2020
Merged
@lzchen lzchen mentioned this issue Dec 9, 2020
Merged
@MrAlias MrAlias mentioned this issue Dec 9, 2020
Merged
@jkwatson jkwatson mentioned this issue Dec 9, 2020
Merged
@mwear mwear mentioned this issue Dec 10, 2020
Closed
@jtescher jtescher mentioned this issue Dec 10, 2020
Merged
This was referenced Dec 10, 2020
Closed
Merged
@cijothomas cijothomas mentioned this issue Dec 11, 2020
Merged
3 tasks
@tedsuo tedsuo mentioned this issue Dec 14, 2020
Merged
tigrannajaryan pushed a commit to open-telemetry/oteps that referenced this issue Dec 16, 2020
@tedsuo
Versioning and Stability for OpenTelemetry Clients (#143)
f101ccb 
Link to readable version: https://github.com/tedsuo/rfcs/blob/versioning/text/0143-versioning-and-stability.md

Versioning is a high priority as we still hope to get some kind of release or announcement out by end of year. This proposal explains the versioning protocol and stability guarantees for OpenTelemetry implementations in every language. 

 It would be a helpful exercise to have maintainers review this proposal, and write out their language specific-expectations.

**Request for Maintainers:** Please create a language-specific document which describes how versioning and support works for your language, based on this OTEP, and post a link to it in the [tracking issue here](open-telemetry/opentelemetry-specification#1267). We want to ensure that versioning and support as been thought through before it is added to the spec.

Cheers,
-T
@andrewhsu andrewhsu mentioned this issue Dec 17, 2020
Closed
7 tasks
@tedsuo
Copy link
Contributor Author

tedsuo commented Jan 22, 2021

Thank you everyone for your participation! We've unlocked v1.0. Since work has successfully moved to the SIGs and implementations; I am closing this issue.

@tedsuo tedsuo closed this as completed Jan 22, 2021
carlosalberto pushed a commit to carlosalberto/opentelemetry-specification that referenced this issue Oct 21, 2024
@tedsuo @carlosalberto
Versioning and Stability for OpenTelemetry Clients (open-telemetry#143)
0ccf798 
Link to readable version: https://github.com/tedsuo/rfcs/blob/versioning/text/0143-versioning-and-stability.md

Versioning is a high priority as we still hope to get some kind of release or announcement out by end of year. This proposal explains the versioning protocol and stability guarantees for OpenTelemetry implementations in every language.

 It would be a helpful exercise to have maintainers review this proposal, and write out their language specific-expectations.

**Request for Maintainers:** Please create a language-specific document which describes how versioning and support works for your language, based on this OTEP, and post a link to it in the [tracking issue here](open-telemetry#1267). We want to ensure that versioning and support as been thought through before it is added to the spec.

Cheers,
-T
carlosalberto pushed a commit to carlosalberto/oteps that referenced this issue Oct 23, 2024
@tedsuo
Versioning and Stability for OpenTelemetry Clients (open-telemetry#143)
74a8638 
Link to readable version: https://github.com/tedsuo/rfcs/blob/versioning/text/0143-versioning-and-stability.md

Versioning is a high priority as we still hope to get some kind of release or announcement out by end of year. This proposal explains the versioning protocol and stability guarantees for OpenTelemetry implementations in every language. 

 It would be a helpful exercise to have maintainers review this proposal, and write out their language specific-expectations.

**Request for Maintainers:** Please create a language-specific document which describes how versioning and support works for your language, based on this OTEP, and post a link to it in the [tracking issue here](open-telemetry/opentelemetry-specification#1267). We want to ensure that versioning and support as been thought through before it is added to the spec.

Cheers,
-T
carlosalberto pushed a commit to carlosalberto/oteps that referenced this issue Oct 23, 2024
@tedsuo
Versioning and Stability for OpenTelemetry Clients (open-telemetry#143)
872fbe9 
Link to readable version: https://github.com/tedsuo/rfcs/blob/versioning/text/0143-versioning-and-stability.md

Versioning is a high priority as we still hope to get some kind of release or announcement out by end of year. This proposal explains the versioning protocol and stability guarantees for OpenTelemetry implementations in every language. 

 It would be a helpful exercise to have maintainers review this proposal, and write out their language specific-expectations.

**Request for Maintainers:** Please create a language-specific document which describes how versioning and support works for your language, based on this OTEP, and post a link to it in the [tracking issue here](open-telemetry/opentelemetry-specification#1267). We want to ensure that versioning and support as been thought through before it is added to the spec.

Cheers,
-T
carlosalberto pushed a commit to carlosalberto/oteps that referenced this issue Oct 30, 2024
@tedsuo
Versioning and Stability for OpenTelemetry Clients (open-telemetry#143)
7c58fa4 
Link to readable version: https://github.com/tedsuo/rfcs/blob/versioning/text/0143-versioning-and-stability.md

Versioning is a high priority as we still hope to get some kind of release or announcement out by end of year. This proposal explains the versioning protocol and stability guarantees for OpenTelemetry implementations in every language. 

 It would be a helpful exercise to have maintainers review this proposal, and write out their language specific-expectations.

**Request for Maintainers:** Please create a language-specific document which describes how versioning and support works for your language, based on this OTEP, and post a link to it in the [tracking issue here](open-telemetry/opentelemetry-specification#1267). We want to ensure that versioning and support as been thought through before it is added to the spec.

Cheers,
-T
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tedsuo tedsuo

Labels
priority:p1 Highest priority level release:required-for-ga Must be resolved before GA release, or nice to have before GA spec:miscellaneous For issues that don't match any other spec label
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@tedsuo @carlosalberto