Skip to content

Update README for alpha release #189

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 2 commits into from
Oct 1, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 41 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,16 @@ The `opentelemetry-sdk` package is the reference implementation of the API.

Libraries that produce telemetry data should only depend on `opentelemetry-api`,
and defer the choice of the SDK to the application developer. Applications may
depend on `opentelemetry-sdk` or another package that implements the API.
depend on `opentelemetry-sdk` or another package that implements the API.

To install the API and SDK packages, fork or clone this repo and do an
[editable
install](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs)
via `pip`:
**Please note** that this library is currently in _alpha_, and shouldn't be
used in production environments.

The API and SDK packages are available on PyPI, and can installed via `pip`:

```sh
pip install -e ./opentelemetry-api
pip install -e ./opentelemetry-sdk
pip install opentelemetry-api
pip install opentelemetry-sdk
```

The
Expand All @@ -34,6 +34,16 @@ directory includes OpenTelemetry integration packages, which can be installed
separately as:

```sh
pip install opentelemetry-ext-{integration}
```

To install the development versions of these packages instead, clone or fork
this repo and do an [editable
install](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs):

```sh
pip install -e ./opentelemetry-api
pip install -e ./opentelemetry-sdk
pip install -e ./ext/opentelemetry-ext-{integration}
```

Expand Down Expand Up @@ -69,21 +79,27 @@ See [CONTRIBUTING.md](CONTRIBUTING.md)

## Release Schedule

OpenTelemetry Python is under active development. Our goal is to release an
_alpha_ version of the library at the end of September 2019. This release isn't
guaranteed to conform to a specific version of the specification, and future
releases will not attempt to maintain backwards compatibility with the alpha
release.

| Component | Version | Target Date |
| --------------------------- | ------- | ----------------- |
| Tracing API | Alpha | September 30 2019 |
| Tracing SDK | Alpha | September 30 2019 |
| Metrics API | Alpha | September 30 2019 |
| Metrics SDK | Alpha | September 30 2019 |
| Zipkin Trace Exporter | Alpha | September 30 2019 |
| Jaeger Trace Exporter | Alpha | Unknown |
| Prometheus Metrics Exporter | Alpha | Unknown |
| Context Propagation | Alpha | September 30 2019 |
| OpenTracing Bridge | Alpha | Unknown |
| OpenCensus Bridge | Alpha | Unknown |
OpenTelemetry Python is under active development.

The library is not yet _generally available_, and releases aren't guaranteed to
conform to a specific version of the specification. Future releases will not
attempt to maintain backwards compatibility with current releases.

The _alpha_ release includes:

- Tracing API
- Tracing SDK
- Metrics API
- Metrics SDK
- W3C Context Propagation
- B3 Context Propagation

Future release targets include:

| Component | Version | Target Date |
| --------------------------- | ------- | --------------- |
| Zipkin Trace Exporter | Beta | October 14 2019 |
| Jaeger Trace Exporter | Beta | October 14 2019 |
| Prometheus Metrics Exporter | Beta | October 14 2019 |
| OpenTracing Bridge | Beta | October 14 2019 |
| OpenCensus Bridge | Beta | October 14 2019 |