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

Add lifecycle statuses to all documents #1385

Merged
merged 8 commits into from
Feb 4, 2021

Conversation

tedsuo
Copy link
Contributor

@tedsuo tedsuo commented Jan 27, 2021

Changes

  • Adds the current lifecycle stage to each document's status.
  • Clarifies that the feature-freeze status is a community process, not a definition of stability or feature-completeness.
  • Sets the status for Tracing SDK, Resource SDK, Context, Propagation, Baggage API, Jaeger Exporter, and Zipkin Exporter to stable.

Related issues #

@tedsuo tedsuo requested review from a team January 27, 2021 21:42
@tedsuo tedsuo mentioned this pull request Jan 27, 2021
@bogdandrutu
Copy link
Member

Please rebase and checks will run

@tedsuo
Copy link
Contributor Author

tedsuo commented Jan 28, 2021

@bogdandrutu resolved

@lzchen
Copy link
Contributor

lzchen commented Jan 28, 2021

I know that environment variables are deemed optional in the spec matrix but some languages have already implemented some of them. In this case, will the env var names be marked as "stable" here as well or will there possible breaking changes in the future (such as the recent OTEL_EXPORTERS -> OTEL_METRICS_EXPORTER + OTEL_TRACE_EXPORTER)? We need to know whether or not we can release env var functionality as part of 1.0.0.

@jsuereth
Copy link
Contributor

I know that environment variables are deemed optional in the spec matrix but some languages have already implemented some of them. In this case, will the env var names be marked as "stable" here as well or will there possible breaking changes in the future (such as the recent OTEL_EXPORTERS -> OTEL_METRICS_EXPORTER + OTEL_TRACE_EXPORTER)? We need to know whether or not we can release env var functionality as part of 1.0.0.

I'd be nice if we could lock down the semantics folks were already relying on here without having to fully lock down everything about environment variables. The OTEL_EXPORTERS change was one where we likely WILL be doing deprecation + migration in the future, and we could have done that here for existing SDKs rather than force migrate prior to 1.0.0.

It'd be nice if we agreed to "1.0" environment variables (even if they're optional, we still won't change semantics in breaking ways). so +1 to answering this question.

@tedsuo
Copy link
Contributor Author

tedsuo commented Jan 30, 2021

@lzchen @jsuereth I think there are two questions about env vars.

  • Have we marked them as stable yet? The answer to that is no.
  • Should we mark them as stable? We better do that soon, IMHO.

Since they are currently experimental, I would like to mark them here as such. A separate issue can then be opened to address making them stable. Does that sound good to you two?

@lzchen
Copy link
Contributor

lzchen commented Feb 1, 2021

@tedsuo
Discussed during 02/01/2021 maintainer's meeting.
Environment variables that are related to tracing will be marked as stable by the 1.0.0 release.

@@ -1,5 +1,7 @@
# OpenTelemetry Protocol Specification

**Status**: [Stable](../document-status.md)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is are discussion in this document about JSON being supported for OTLP/HTTP which I think we are not yet ready to make it stable. How can we solve that?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I marked OTLP/HTTP as experimental. The JSON and binary formats for HTTP were intermixed; if we want proto over OTLP/HTTP to be stable this section should be re-written.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OTLP/HTTP-Protobufs are stable. Only OTLP/HTTP-JSON is unstable. Please file a TODO to fix this.

We should probably also note that only Traces are currently stable. Looks like we are going to end up with a lot of clarifications for our stability declarations in this file to be true, but that's the reality.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @tigrannajaryan. I created a follow up issue: #1397

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bogdandrutu Please review. I think that we are ready to merge this and tune the OTLP/JSON part in the related follow up.

Copy link
Member

@reyang reyang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@carlosalberto carlosalberto merged commit 1afab39 into open-telemetry:main Feb 4, 2021
@Sachin1O1
Copy link

I guess, we need to update the status of the doc again or is it still in experimental?

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

Successfully merging this pull request may close these issues.