Skip to content

Commit b51cedf

Browse files
authored
add stability status to libraries (#1446)
1 parent d45b740 commit b51cedf

File tree

1 file changed

+31
-23
lines changed

1 file changed

+31
-23
lines changed

README.md

Lines changed: 31 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,29 +9,37 @@ feature or via instrumentation, this project is hopefully for you.
99

1010
## Provided Libraries
1111

12-
* [AWS Resources](./aws-resources/README.md)
13-
* [AWS X-Ray SDK Support](./aws-xray/README.md)
14-
* [AWS X-Ray Propagator](./aws-xray-propagator/README.md)
15-
* [Baggage Span Processor](./baggage-processor/README.md)
16-
* [zstd Compressor](./compressors/compressor-zstd/README.md)
17-
* [Consistent Sampling](./consistent-sampling/README.md)
18-
* [Disk Buffering](./disk-buffering/README.md)
19-
* [GCP Resources](./gcp-resources/README.md)
20-
* [Inferred Spans](./inferred-spans/README.md)
21-
* [JFR Connection](./jfr-connection/README.md)
22-
* [JFR Events](./jfr-events/README.md)
23-
* [JMX Metric Gatherer](./jmx-metrics/README.md)
24-
* [Kafka Support](./kafka-exporter/README.md)
25-
* [OpenTelemetry Maven Extension](./maven-extension/README.md)
26-
* [Micrometer MeterProvider](./micrometer-meter-provider/README.md)
27-
* [No-Op API](./noop-api/README.md)
28-
* [Intercept and Process Signals Globally](./processors/README.md)
29-
* [Prometheus Client Bridge](./prometheus-client-bridge/README.md)
30-
* [Resource Providers](./resource-providers/README.md)
31-
* [Runtime Attach](./runtime-attach/README.md)
32-
* [Samplers](./samplers/README.md)
33-
* [Span Stacktrace Capture](./span-stacktrace/README.md)
34-
* [Static Instrumenter](./static-instrumenter/README.md)
12+
| Status* | Library |
13+
| ------- | ----------------------------------------------------------------- |
14+
| beta | [AWS Resources](./aws-resources/README.md) |
15+
| stable | [AWS X-Ray SDK Support](./aws-xray/README.md) |
16+
| alpha | [AWS X-Ray Propagator](./aws-xray-propagator/README.md) |
17+
| alpha | [Baggage Span Processor](./baggage-processor/README.md) |
18+
| alpha | [zstd Compressor](./compressors/compressor-zstd/README.md) |
19+
| alpha | [Consistent Sampling](./consistent-sampling/README.md) |
20+
| alpha | [Disk Buffering](./disk-buffering/README.md) |
21+
| beta | [GCP Resources](./gcp-resources/README.md) |
22+
| beta | [Inferred Spans](./inferred-spans/README.md) |
23+
| alpha | [JFR Connection](./jfr-connection/README.md) |
24+
| alpha | [JFR Events](./jfr-events/README.md) |
25+
| alpha | [JMX Metric Gatherer](./jmx-metrics/README.md) |
26+
| alpha | [Kafka Support](./kafka-exporter/README.md) |
27+
| alpha | [OpenTelemetry Maven Extension](./maven-extension/README.md) |
28+
| alpha | [Micrometer MeterProvider](./micrometer-meter-provider/README.md) |
29+
| alpha | [No-Op API](./noop-api/README.md) |
30+
| alpha | [Intercept and Process Signals Globally](./processors/README.md) |
31+
| alpha | [Prometheus Client Bridge](./prometheus-client-bridge/README.md) |
32+
| alpha | [Resource Providers](./resource-providers/README.md) |
33+
| alpha | [Runtime Attach](./runtime-attach/README.md) |
34+
| alpha | [Samplers](./samplers/README.md) |
35+
| beta | [Span Stacktrace Capture](./span-stacktrace/README.md) |
36+
| alpha | [Static Instrumenter](./static-instrumenter/README.md) |
37+
38+
\* `alpha`, `beta` and `stable` are currently used to denote library status per [otep 0232](https://github.com/open-telemetry/oteps/blob/main/text/0232-maturity-of-otel.md).
39+
To reach stable status, the library needs to have stable APIs, stable semantic conventions, and be production ready.
40+
On reaching stable status, the `otel.stable` value in `gradle.properties` should be set to `true`.
41+
Note that currently all the libraries are released together with the version of this repo, so breaking changes (after stable
42+
status is reached) would bump the major version of all libraries together. This could get complicated so `stable` has a high bar.
3543

3644
## Getting Started
3745

0 commit comments

Comments
 (0)