@@ -16,16 +16,16 @@ The `opentelemetry-sdk` package is the reference implementation of the API.
16
16
17
17
Libraries that produce telemetry data should only depend on ` opentelemetry-api ` ,
18
18
and defer the choice of the SDK to the application developer. Applications may
19
- depend on ` opentelemetry-sdk ` or another package that implements the API.
19
+ depend on ` opentelemetry-sdk ` or another package that implements the API.
20
20
21
- To install the API and SDK packages, fork or clone this repo and do an
22
- [ editable
23
- install ] ( https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs )
24
- via ` pip ` :
21
+ ** Please note ** that this library is currently in _ alpha _ , and shouldn't be
22
+ used in production environments.
23
+
24
+ The API and SDK packages are available on PyPI, and can installed via ` pip ` :
25
25
26
26
``` sh
27
- pip install -e ./ opentelemetry-api
28
- pip install -e ./ opentelemetry-sdk
27
+ pip install opentelemetry-api
28
+ pip install opentelemetry-sdk
29
29
```
30
30
31
31
The
@@ -34,6 +34,16 @@ directory includes OpenTelemetry integration packages, which can be installed
34
34
separately as:
35
35
36
36
``` sh
37
+ pip install opentelemetry-ext-{integration}
38
+ ```
39
+
40
+ To install the development versions of these packages instead, clone or fork
41
+ this repo and do an [ editable
42
+ install] ( https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs ) :
43
+
44
+ ``` sh
45
+ pip install -e ./opentelemetry-api
46
+ pip install -e ./opentelemetry-sdk
37
47
pip install -e ./ext/opentelemetry-ext-{integration}
38
48
```
39
49
@@ -69,21 +79,27 @@ See [CONTRIBUTING.md](CONTRIBUTING.md)
69
79
70
80
## Release Schedule
71
81
72
- OpenTelemetry Python is under active development. Our goal is to release an
73
- _ alpha_ version of the library at the end of September 2019. This release isn't
74
- guaranteed to conform to a specific version of the specification, and future
75
- releases will not attempt to maintain backwards compatibility with the alpha
76
- release.
77
-
78
- | Component | Version | Target Date |
79
- | --------------------------- | ------- | ----------------- |
80
- | Tracing API | Alpha | September 30 2019 |
81
- | Tracing SDK | Alpha | September 30 2019 |
82
- | Metrics API | Alpha | September 30 2019 |
83
- | Metrics SDK | Alpha | September 30 2019 |
84
- | Zipkin Trace Exporter | Alpha | September 30 2019 |
85
- | Jaeger Trace Exporter | Alpha | Unknown |
86
- | Prometheus Metrics Exporter | Alpha | Unknown |
87
- | Context Propagation | Alpha | September 30 2019 |
88
- | OpenTracing Bridge | Alpha | Unknown |
89
- | OpenCensus Bridge | Alpha | Unknown |
82
+ OpenTelemetry Python is under active development.
83
+
84
+ The library is not yet _ generally available_ , and releases aren't guaranteed to
85
+ conform to a specific version of the specification. Future releases will not
86
+ attempt to maintain backwards compatibility with current releases.
87
+
88
+ The _ alpha_ release includes:
89
+
90
+ - Tracing API
91
+ - Tracing SDK
92
+ - Metrics API
93
+ - Metrics SDK
94
+ - W3C Context Propagation
95
+ - B3 Context Propagation
96
+
97
+ Future release targets include:
98
+
99
+ | Component | Version | Target Date |
100
+ | --------------------------- | ------- | --------------- |
101
+ | Zipkin Trace Exporter | Beta | October 14 2019 |
102
+ | Jaeger Trace Exporter | Beta | October 14 2019 |
103
+ | Prometheus Metrics Exporter | Beta | October 14 2019 |
104
+ | OpenTracing Bridge | Beta | October 14 2019 |
105
+ | OpenCensus Bridge | Beta | October 14 2019 |
0 commit comments