diff --git a/CHANGELOG.md b/CHANGELOG.md index bca0bb7ae..8ac7a6eca 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,18 @@ ## Unreleased -Full list of differences found in [this compare](https://github.com/open-telemetry/opentelemetry-proto/compare/v0.20.0...main). +Full list of differences found in [this compare](https://github.com/open-telemetry/opentelemetry-proto/compare/v1.0.0...main). + +## 1.0.0 - 2023-07-03 + +Full list of differences found in [this compare](https://github.com/open-telemetry/opentelemetry-proto/compare/v0.20.0...v1.0.0). + +### Maturity + +* Add note about the possibility to have unstable components after 1.0.0 + [#489](https://github.com/open-telemetry/opentelemetry-proto/pull/489) +* Add maturity JSON entry per package + [#490](https://github.com/open-telemetry/opentelemetry-proto/pull/490) ## 0.20.0 - 2023-06-06 diff --git a/README.md b/README.md index ca2695885..d22b11899 100644 --- a/README.md +++ b/README.md @@ -33,16 +33,16 @@ To generate the raw gRPC client libraries, use `make gen-${LANGUAGE}`. Currently ## Maturity Level -Component | Maturity | --------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------| -**Binary Protobuf Encoding** | | -common/* | Stable | -metrics/\*
collector/metrics/* | Stable | -resource/* | Stable | -trace/\*
collector/trace/* | Stable | -logs/\*
collector/logs/* | Stable | -**JSON encoding** | | -All messages | [Stable](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/otlp.md#json-protobuf-encoding) | +1.0.0 and newer releases from this repository may contain unstable (alpha or beta) +components as indicated by the Maturity table below. + +| Component | Binary Protobuf Maturity | JSON Maturity | +| --------- |--------------- | ------------- | +| common/* | Stable | [Stable](docs/specification.md#json-protobuf-encoding) | +| resource/* | Stable | [Stable](docs/specification.md#json-protobuf-encoding) | +| metrics/\*
collector/metrics/* | Stable | [Stable](docs/specification.md#json-protobuf-encoding) | +| trace/\*
collector/trace/* | Stable | [Stable](docs/specification.md#json-protobuf-encoding) | +| logs/\*
collector/logs/* | Stable | [Stable](docs/specification.md#json-protobuf-encoding) | (See [maturity-matrix.yaml](https://github.com/open-telemetry/community/blob/47813530864b9fe5a5146f466a58bd2bb94edc72/maturity-matrix.yaml#L57) for definition of maturity levels). diff --git a/docs/specification.md b/docs/specification.md index c36023f88..a4bcb13cc 100644 --- a/docs/specification.md +++ b/docs/specification.md @@ -169,7 +169,7 @@ If the server receives an empty request (a request that does not carry any telemetry data) the server SHOULD respond with success. On success, the server response MUST be a -[ExportServiceResponse](../opentelemetry/proto/collector) +[Export\ServiceResponse](../opentelemetry/proto/collector) message (`ExportTraceServiceResponse` for traces, `ExportMetricsServiceResponse` for metrics and `ExportLogsServiceResponse` for logs). @@ -182,7 +182,7 @@ in case of a successful response. If the request is only partially accepted (i.e. when the server accepts only parts of the data and rejects the rest), the server response MUST be the same -[ExportServiceResponse](../opentelemetry/proto/collector) +[Export\ServiceResponse](../opentelemetry/proto/collector) message as in the [Full Success](#full-success) case. Additionally, the server MUST initialize the `partial_success` field @@ -492,7 +492,7 @@ If the server receives an empty request (a request that does not carry any telemetry data) the server SHOULD respond with success. On success, the server MUST respond with `HTTP 200 OK`. The response body MUST be -a Protobuf-encoded [ExportServiceResponse](../opentelemetry/proto/collector) +a Protobuf-encoded [Export\ServiceResponse](../opentelemetry/proto/collector) message (`ExportTraceServiceResponse` for traces, `ExportMetricsServiceResponse` for metrics and `ExportLogsServiceResponse` for logs). @@ -505,7 +505,7 @@ in case of a successful response. If the request is only partially accepted (i.e. when the server accepts only parts of the data and rejects the rest), the server MUST respond with `HTTP 200 OK`. The response body MUST be the same -[ExportServiceResponse](../opentelemetry/proto/collector) +[Export\ServiceResponse](../opentelemetry/proto/collector) message as in the [Full Success](#full-success-1) case. Additionally, the server MUST initialize the `partial_success` field diff --git a/examples/metrics.json b/examples/metrics.json index b3143a5c8..2b4592205 100644 --- a/examples/metrics.json +++ b/examples/metrics.json @@ -29,7 +29,7 @@ { "name": "my.counter", "unit": "1", - "description": "I'm a Counter", + "description": "I am a Counter", "sum": { "aggregationTemporality": 1, "isMonotonic": true, @@ -53,7 +53,7 @@ { "name": "my.gauge", "unit": "1", - "description": "I'm a Gauge", + "description": "I am a Gauge", "gauge": { "dataPoints": [ { @@ -74,7 +74,7 @@ { "name": "my.histogram", "unit": "1", - "description": "I'm a Histogram", + "description": "I am a Histogram", "histogram": { "aggregationTemporality": 1, "dataPoints": [ @@ -104,4 +104,4 @@ ] } ] -} \ No newline at end of file +}