From 8fffddef397a14512d503a471d9b454e654cac4a Mon Sep 17 00:00:00 2001 From: Chris Kleinknecht Date: Mon, 30 Sep 2019 14:21:28 -0700 Subject: [PATCH 1/2] Update README for alpha release --- README.md | 66 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 41 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index f8a6f125cca..49e3658b070 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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} ``` @@ -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 +- Zipkin Trace Exporter +- W3C Context Propagation +- B3 Context Propagation + +Future release targets include: + +| Component | Version | Target Date | +| --------------------------- | ------- | --------------- | +| 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 | From 73beeaaf17c65b18859ba3077474308ee8361fb9 Mon Sep 17 00:00:00 2001 From: Chris Kleinknecht Date: Mon, 30 Sep 2019 14:57:07 -0700 Subject: [PATCH 2/2] Move zipkin exporter to beta --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 49e3658b070..eac0a23727b 100644 --- a/README.md +++ b/README.md @@ -91,7 +91,6 @@ The _alpha_ release includes: - Tracing SDK - Metrics API - Metrics SDK -- Zipkin Trace Exporter - W3C Context Propagation - B3 Context Propagation @@ -99,6 +98,7 @@ 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 |