From 76dbb5f52d03067c149029491b815ed09167de62 Mon Sep 17 00:00:00 2001 From: Jack Shirazi Date: Thu, 5 Sep 2024 13:45:52 +0100 Subject: [PATCH 1/3] add stability status to libraries --- README.md | 48 +++++++++++++++++++++++++----------------------- 1 file changed, 25 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 03b3bf559..e27e1b176 100644 --- a/README.md +++ b/README.md @@ -9,29 +9,31 @@ feature or via instrumentation, this project is hopefully for you. ## Provided Libraries -* [AWS Resources](./aws-resources/README.md) -* [AWS X-Ray SDK Support](./aws-xray/README.md) -* [AWS X-Ray Propagator](./aws-xray-propagator/README.md) -* [Baggage Span Processor](./baggage-processor/README.md) -* [zstd Compressor](./compressors/compressor-zstd/README.md) -* [Consistent Sampling](./consistent-sampling/README.md) -* [Disk Buffering](./disk-buffering/README.md) -* [GCP Resources](./gcp-resources/README.md) -* [Inferred Spans](./inferred-spans/README.md) -* [JFR Connection](./jfr-connection/README.md) -* [JFR Events](./jfr-events/README.md) -* [JMX Metric Gatherer](./jmx-metrics/README.md) -* [Kafka Support](./kafka-exporter/README.md) -* [OpenTelemetry Maven Extension](./maven-extension/README.md) -* [Micrometer MeterProvider](./micrometer-meter-provider/README.md) -* [No-Op API](./noop-api/README.md) -* [Intercept and Process Signals Globally](./processors/README.md) -* [Prometheus Client Bridge](./prometheus-client-bridge/README.md) -* [Resource Providers](./resource-providers/README.md) -* [Runtime Attach](./runtime-attach/README.md) -* [Samplers](./samplers/README.md) -* [Span Stacktrace Capture](./span-stacktrace/README.md) -* [Static Instrumenter](./static-instrumenter/README.md) +| Status | Library | +| ------ | ----------------------------------------------------------------- | +| beta | [AWS Resources](./aws-resources/README.md) | +| stable | [AWS X-Ray SDK Support](./aws-xray/README.md) | +| beta | [AWS X-Ray Propagator](./aws-xray-propagator/README.md) | +| beta | [Baggage Span Processor](./baggage-processor/README.md) | +| beta | [zstd Compressor](./compressors/compressor-zstd/README.md) | +| beta | [Consistent Sampling](./consistent-sampling/README.md) | +| beta | [Disk Buffering](./disk-buffering/README.md) | +| beta | [GCP Resources](./gcp-resources/README.md) | +| beta | [Inferred Spans](./inferred-spans/README.md) | +| beta | [JFR Connection](./jfr-connection/README.md) | +| beta | [JFR Events](./jfr-events/README.md) | +| beta | [JMX Metric Gatherer](./jmx-metrics/README.md) | +| beta | [Kafka Support](./kafka-exporter/README.md) | +| beta | [OpenTelemetry Maven Extension](./maven-extension/README.md) | +| beta | [Micrometer MeterProvider](./micrometer-meter-provider/README.md) | +| beta | [No-Op API](./noop-api/README.md) | +| beta | [Intercept and Process Signals Globally](./processors/README.md) | +| beta | [Prometheus Client Bridge](./prometheus-client-bridge/README.md) | +| beta | [Resource Providers](./resource-providers/README.md) | +| beta | [Runtime Attach](./runtime-attach/README.md) | +| beta | [Samplers](./samplers/README.md) | +| beta | [Span Stacktrace Capture](./span-stacktrace/README.md) | +| beta | [Static Instrumenter](./static-instrumenter/README.md) | ## Getting Started From b2988287dd1f45844cfb7a3893d72652481c5afa Mon Sep 17 00:00:00 2001 From: Jack Shirazi Date: Mon, 16 Sep 2024 18:11:10 +0100 Subject: [PATCH 2/3] update to add in discussions comments --- README.md | 56 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 31 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index e27e1b176..99872d336 100644 --- a/README.md +++ b/README.md @@ -9,31 +9,37 @@ feature or via instrumentation, this project is hopefully for you. ## Provided Libraries -| Status | Library | -| ------ | ----------------------------------------------------------------- | -| beta | [AWS Resources](./aws-resources/README.md) | -| stable | [AWS X-Ray SDK Support](./aws-xray/README.md) | -| beta | [AWS X-Ray Propagator](./aws-xray-propagator/README.md) | -| beta | [Baggage Span Processor](./baggage-processor/README.md) | -| beta | [zstd Compressor](./compressors/compressor-zstd/README.md) | -| beta | [Consistent Sampling](./consistent-sampling/README.md) | -| beta | [Disk Buffering](./disk-buffering/README.md) | -| beta | [GCP Resources](./gcp-resources/README.md) | -| beta | [Inferred Spans](./inferred-spans/README.md) | -| beta | [JFR Connection](./jfr-connection/README.md) | -| beta | [JFR Events](./jfr-events/README.md) | -| beta | [JMX Metric Gatherer](./jmx-metrics/README.md) | -| beta | [Kafka Support](./kafka-exporter/README.md) | -| beta | [OpenTelemetry Maven Extension](./maven-extension/README.md) | -| beta | [Micrometer MeterProvider](./micrometer-meter-provider/README.md) | -| beta | [No-Op API](./noop-api/README.md) | -| beta | [Intercept and Process Signals Globally](./processors/README.md) | -| beta | [Prometheus Client Bridge](./prometheus-client-bridge/README.md) | -| beta | [Resource Providers](./resource-providers/README.md) | -| beta | [Runtime Attach](./runtime-attach/README.md) | -| beta | [Samplers](./samplers/README.md) | -| beta | [Span Stacktrace Capture](./span-stacktrace/README.md) | -| beta | [Static Instrumenter](./static-instrumenter/README.md) | +| Status* | Library | +| ------- | ----------------------------------------------------------------- | +| beta | [AWS Resources](./aws-resources/README.md) | +| stable | [AWS X-Ray SDK Support](./aws-xray/README.md) | +| alpha | [AWS X-Ray Propagator](./aws-xray-propagator/README.md) | +| alpha | [Baggage Span Processor](./baggage-processor/README.md) | +| alpha | [zstd Compressor](./compressors/compressor-zstd/README.md) | +| alpha | [Consistent Sampling](./consistent-sampling/README.md) | +| alpha | [Disk Buffering](./disk-buffering/README.md) | +| beta | [GCP Resources](./gcp-resources/README.md) | +| beta | [Inferred Spans](./inferred-spans/README.md) | +| alpha | [JFR Connection](./jfr-connection/README.md) | +| alpha | [JFR Events](./jfr-events/README.md) | +| alpha | [JMX Metric Gatherer](./jmx-metrics/README.md) | +| alpha | [Kafka Support](./kafka-exporter/README.md) | +| alpha | [OpenTelemetry Maven Extension](./maven-extension/README.md) | +| alpha | [Micrometer MeterProvider](./micrometer-meter-provider/README.md) | +| alpha | [No-Op API](./noop-api/README.md) | +| alpha | [Intercept and Process Signals Globally](./processors/README.md) | +| alpha | [Prometheus Client Bridge](./prometheus-client-bridge/README.md) | +| alpha | [Resource Providers](./resource-providers/README.md) | +| alpha | [Runtime Attach](./runtime-attach/README.md) | +| alpha | [Samplers](./samplers/README.md) | +| beta | [Span Stacktrace Capture](./span-stacktrace/README.md) | +| alpha | [Static Instrumenter](./static-instrumenter/README.md) | + +* `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). +To reach stable status, the library needs to have stable APIs, stable semantic conventions, and be production ready. +On reaching stable status, the `otel.stable` value in `gradle.properties` should be set to `true`. +Note that currently all the libraries are released together with the version of this repo, so breaking changes (after stable +status is reached) would bump the major version of all libraries together. This could get complicated so `stable` has a high bar. ## Getting Started From 3a0bd2da636038205b89af2eccc84d9e2b1489b3 Mon Sep 17 00:00:00 2001 From: Jack Shirazi Date: Mon, 16 Sep 2024 18:14:18 +0100 Subject: [PATCH 3/3] escape asterisk --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 99872d336..dd10e91e6 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ feature or via instrumentation, this project is hopefully for you. | beta | [Span Stacktrace Capture](./span-stacktrace/README.md) | | alpha | [Static Instrumenter](./static-instrumenter/README.md) | -* `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). +\* `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). To reach stable status, the library needs to have stable APIs, stable semantic conventions, and be production ready. On reaching stable status, the `otel.stable` value in `gradle.properties` should be set to `true`. Note that currently all the libraries are released together with the version of this repo, so breaking changes (after stable