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

WIP: Initial Milestones #50

Closed
wants to merge 8 commits into from
Closed

WIP: Initial Milestones #50

wants to merge 8 commits into from

Conversation

tedsuo
Copy link
Contributor

@tedsuo tedsuo commented May 16, 2019

This document covers the project setup and initial milestones for language implementations of OpenTelemetry, based on the public roadmap.

See comments in line for open questions.

docs/project-setup.md Outdated Show resolved Hide resolved
docs/project-setup.md Outdated Show resolved Hide resolved
docs/project-setup.md Outdated Show resolved Hide resolved
docs/project-setup.md Outdated Show resolved Hide resolved
docs/project-setup.md Outdated Show resolved Hide resolved
docs/project-setup.md Outdated Show resolved Hide resolved
@tedsuo tedsuo changed the title WIP: Initial project setup documentation WIP: Initial Milestones May 28, 2019
@tedsuo
Copy link
Contributor Author

tedsuo commented May 28, 2019

Hi all. Based on feedback, I simplified this doc to just focus on the initial milestones. Please have a look at these milestones. If they look basically good, I would like to merge this so that others can then make PRs and start editing.

Cheers!


Parity can be defined as the following milestones:
* A set of interfaces which define the OpenTelemetry Specification in a given programming language.
* An SDK which can propagate context and record data in common formats.
Copy link
Member

Choose a reason for hiding this comment

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

why we are not saying that SDK should satisfy specification? There will be a spec for SDK.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I feel it is important to make it clear that the interfaces are separate from the SDK, so that it is possible to have more than one implementation. I would like suggestions on how to make requirements such as this clear to everyone.

Copy link
Member

Choose a reason for hiding this comment

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

I just meant to keep it as separate line, bit instead of saying these two things - context and recording data - just say SDK implementing the specification

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's a good question! I expect that there are features which we will want to implement in the SDK, but which are not strictly necessary for reaching parity and sunsetting the old projects. So we should to be specific about which SDK features are required to hit our deadlines, vs which could be added later without a problem.

I'm fine with reorganizing the SDK milestones, but that was my thinking.

Copy link
Member

Choose a reason for hiding this comment

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

propagate context and record data in common format is very vague. Does it include metrics aggregation or it can be left out for instance? Maybe spec needs to have 1.0 requirements subfolder or something. Combined with the common test cases


### SDK: Export Common Data Formats
* Export data in OpenTelemetry format
* Export data in custom format
Copy link
Member

Choose a reason for hiding this comment

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

this also belongs to spec as we need to define two or three "required" OSS backends with the definition on HOW to export there (basically conversion model)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Agreed

Copy link
Member

Choose a reason for hiding this comment

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

So again. I'd simply refer to the spec. Saing "support as a minimum things listed in a spec for the release 1.0"

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, sounds good. I like the idea of the spec making it clear what is v1.0.

Copy link
Member

@SergeyKanzhelev SergeyKanzhelev left a comment

Choose a reason for hiding this comment

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

I think it's a good document to provide clarity on what we are doing. I left a few comments

docs/initial-milestones.md Outdated Show resolved Hide resolved
docs/initial-milestones.md Outdated Show resolved Hide resolved
docs/initial-milestones.md Outdated Show resolved Hide resolved
@tedsuo
Copy link
Contributor Author

tedsuo commented May 30, 2019

Updated again. If we are mostly okay with the current state, I would like to move this over to the specification repo and commit it, then continue to refine it as the spec evolves.

@@ -0,0 +1,68 @@
# OpenTelemetry: A Roadmap to Convergence

This document covers the intial milestones for each repository developing an implementation of the OpenTelemetry Specification for a specific language. For each new language, we want to quickly achieve parity with existing OpenTracing and OpenCensus implementations.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
This document covers the intial milestones for each repository developing an implementation of the OpenTelemetry Specification for a specific language. For each new language, we want to quickly achieve parity with existing OpenTracing and OpenCensus implementations.
This document covers the initial milestones for each repository developing an implementation of the OpenTelemetry Specification for a specific language. For each new language, we want to quickly achieve parity with existing OpenTracing and OpenCensus implementations.

* Add the milestones listed below to the backlog.

## Initial Milestones
For languages which have both an OpenTracing and OpenCensus implementation, we would like to achieve parity in OpenTelemetry by **September, 2019**, and sunset the existing OpenTracing and OpenCensus ptojects by **November, 2019**.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
For languages which have both an OpenTracing and OpenCensus implementation, we would like to achieve parity in OpenTelemetry by **September, 2019**, and sunset the existing OpenTracing and OpenCensus ptojects by **November, 2019**.
For languages which have both an OpenTracing and OpenCensus implementation, we would like to achieve parity in OpenTelemetry by **September, 2019**, and sunset the existing OpenTracing and OpenCensus projects by **November, 2019**.

* Utilities to record this data easily

### SDK: OpenTracing Bridge
* The OpenTelemtry SDK implements the latest version of the OpenTracing interface.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* The OpenTelemtry SDK implements the latest version of the OpenTracing interface.
* The OpenTelemetry SDK implements the latest version of the OpenTracing interface.

* Interoperability tests using OpenTracing and OpenTelemetry instrumentation together.

### SDK: OpenCensus Bridge
* implement a version of OpenCensus which bridges to OpenTelemetry.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* implement a version of OpenCensus which bridges to OpenTelemetry.
* Implement a version of OpenCensus which bridges to OpenTelemetry.

@c24t
Copy link
Member

c24t commented May 30, 2019

@tedsuo do you want to use these as github milestones in the client repos? If so it looks like we need milestones for the SDK implementation.

@SergeyKanzhelev
Copy link
Member

The way it goes now - for the specification and languages adoption I think we will need something like this before september:

And similar thing for SDK adopting these revisions.

Without these milestones we cannot get out of the cycle of discussing everything and not closing on issues.

@SergeyKanzhelev
Copy link
Member

Submitted a separate PR with this one as a starting point.

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.

10 participants