Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Flesh out README, add release schedule #127

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

Merged
merged 6 commits into from
Sep 10, 2019

Conversation

c24t
Copy link
Member

@c24t c24t commented Sep 7, 2019

Quick PR to add target release dates to the README following @tedsuo's comment on gitter.

My request: We’d like to start communicating more clearly about the state of each implementation. Please update the README to have section at the top with the following:

Current state of the project, with a focus on the items listed in the alpha description
Installation and super basic quick start guide

| Prometheus Metrics Exporter | Alpha | Unknown |
| Context Propagation | Alpha | September 30 2019 |
| OpenTracing Bridge | Alpha | Unknown |
Copy link
Member

Choose a reason for hiding this comment

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

IIRC OpenTracing Bridge for Python has targeted 9/30, please help to double check.

Copy link
Member

Choose a reason for hiding this comment

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

In the Python SIG meeting of 2019-08-29 with @tedsuo we said that we can't promise anything for the bridges yet because they requirements for them are underspecified. I think the remaining goals are ambitious enough (considering e.g. the current state of the context propagation spec discussion).

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't know that we need the OpenTracing bridge for the alpha release, and it's unlikely that we'd get the OC bridge done by then. If it looks like we'll get it out in time we can update the date, here or in another PR.

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.

LGTM.

Copy link
Member

@toumorokoshi toumorokoshi left a comment

Choose a reason for hiding this comment

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

I feel somewhat strongly about the tox stuff moving to contributing.md, but looks good!

| Context Propagation | Alpha | September 30 2019 |
| OpenTracing Bridge | Alpha | Unknown |
| OpenCensus Bridge | Alpha | Unknown |
Copy link
Member

Choose a reason for hiding this comment

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

is it worth covering propagation/formatters supported? We have B3 header support now, and I believe @a-feld is working on tracestate.

Copy link
Member

Choose a reason for hiding this comment

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

That's why I think that the bridges are underspecified. A minimal bridge IMHO only needs to support instrumenting code, i.e. is completely independent of concrete propagators/formatters. But of course, a more complete compatibility would also imply support for all propagators and exporters that OC supports, including OC's own protocol (100% compat would even need to support plugging existing OC exporters into opentelemetry-python, but I don't think we are aiming for that). Which reminds me that the OC bridge will be somewhat trickier than the OT bridge because since there is no API layer, we will probably need to occupy the same package names that OC does to support migration without source modification?

Copy link
Member Author

Choose a reason for hiding this comment

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

These topics mostly come from @tedsuo's release doc: https://docs.google.com/spreadsheets/d/1FHt3uJgQWN-UWbgV4uMIPUr36JiJCfZ7ryQbHfurjKA/edit#gid=0. There's a checklist section at the bottom that includes the Jaeger and Prometheus exporters, but I didn't include them here. If we want to commit to including them in the release we can add them.

I didn't include either bridge, but we may want to include at least the OpenTracing bridge here too and leave OC for a later release.

specification](https://github.com/open-telemetry/opentelemetry-specification).
The `opentelemetry-sdk` package is the reference implementation of the API.

To install the API and SDK packages, fork or clone this repo and do an
Copy link
Member

Choose a reason for hiding this comment

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

We could mention the pip install PKG@git+https://github.com/open-telemetry/opentelemetry-python.git@COMMIT_OR_BRANCH_OR_TAG#egg=PKG&subdirectory=PKG option too, this way pip does the git clone for you.

Copy link
Member Author

Choose a reason for hiding this comment

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

I thought about adding this, but there's a lot of benefit to keeping the readme short and... readable. Most people won't need this -- I think it's fine to leave other installation options as an exercise for the reader.

Copy link
Member

Choose a reason for hiding this comment

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

I agree that keeping readme short and readable is a higher priority.
Maybe later we could explore similar thing here https://github.com/census-instrumentation/opencensus-python/pull/549/files.

The `opentelemetry-sdk` package is the reference implementation of the API.

To install the API and SDK packages, fork or clone this repo and do an
[editable
Copy link
Member

Choose a reason for hiding this comment

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

Why do we recommend the editable install?

Copy link
Member Author

Choose a reason for hiding this comment

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

Only because we haven't pushed anything to PyPI yet. I don't have a strong opinion on this vs. python setup.py install, but it looks like there are a few good reasons to prefer pip here.

| Prometheus Metrics Exporter | Alpha | Unknown |
| Context Propagation | Alpha | September 30 2019 |
| OpenTracing Bridge | Alpha | Unknown |
Copy link
Member

Choose a reason for hiding this comment

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

In the Python SIG meeting of 2019-08-29 with @tedsuo we said that we can't promise anything for the bridges yet because they requirements for them are underspecified. I think the remaining goals are ambitious enough (considering e.g. the current state of the context propagation spec discussion).

| Context Propagation | Alpha | September 30 2019 |
| OpenTracing Bridge | Alpha | Unknown |
| OpenCensus Bridge | Alpha | Unknown |
Copy link
Member

Choose a reason for hiding this comment

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

That's why I think that the bridges are underspecified. A minimal bridge IMHO only needs to support instrumenting code, i.e. is completely independent of concrete propagators/formatters. But of course, a more complete compatibility would also imply support for all propagators and exporters that OC supports, including OC's own protocol (100% compat would even need to support plugging existing OC exporters into opentelemetry-python, but I don't think we are aiming for that). Which reminds me that the OC bridge will be somewhat trickier than the OT bridge because since there is no API layer, we will probably need to occupy the same package names that OC does to support migration without source modification?

@c24t
Copy link
Member Author

c24t commented Sep 9, 2019

@Oberon00 let me know if my changes address your comments and I'll merge if so (or feel free to merge it yourself).

@Oberon00 Oberon00 merged commit 17bef26 into open-telemetry:master Sep 10, 2019
@c24t c24t deleted the readme-for-alpha-release branch September 10, 2019 19:41
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.

4 participants