From 0c5c9da17d0ac4cab11aaafeecc915e0193af6be Mon Sep 17 00:00:00 2001 From: Tigran Najaryan Date: Fri, 16 Oct 2020 15:32:54 -0400 Subject: [PATCH 1/2] Clarify maturity guarantees This clarifies what is and is not part of the promises. --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index e7bfca76c..ce57f08a4 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,13 @@ All messages | Alpha | (See [maturity-matrix.yaml](https://github.com/open-telemetry/community/blob/47813530864b9fe5a5146f466a58bd2bb94edc72/maturity-matrix.yaml#L57) for definition of maturity levels). +Note that maturity guarantees apply only to wire-level compatibility. Message, field, enum +names of Protobuf messages are not visible on the wire and are not considered part of the +guarantees. We are free to make change to the names. + +In the future when OTLP/JSON is declared stable field names will also become part of +the maturity guarantees since field names are visible on the wire for JSON encoding. + ## Experiments In some cases we are trying to experiment with different features. In this case From b85e35127fba44b729ccea7581fdff197edf6147 Mon Sep 17 00:00:00 2001 From: Tigran Najaryan Date: Mon, 19 Oct 2020 12:33:38 -0400 Subject: [PATCH 2/2] Made a few fixes based on PR comments --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ce57f08a4..d978dafde 100644 --- a/README.md +++ b/README.md @@ -24,12 +24,13 @@ All messages | Alpha | (See [maturity-matrix.yaml](https://github.com/open-telemetry/community/blob/47813530864b9fe5a5146f466a58bd2bb94edc72/maturity-matrix.yaml#L57) for definition of maturity levels). -Note that maturity guarantees apply only to wire-level compatibility. Message, field, enum -names of Protobuf messages are not visible on the wire and are not considered part of the -guarantees. We are free to make change to the names. +Note that maturity guarantees apply only to wire-level compatibility for the binary +Protobuf serialization. Neither message, field, nor enum names of Protobuf messages +are visible on the wire and are not considered part of the guarantees. We are free +to make change to the names. -In the future when OTLP/JSON is declared stable field names will also become part of -the maturity guarantees since field names are visible on the wire for JSON encoding. +In the future when OTLP/JSON is declared stable, field names will also become part of +the maturity guarantees, since field names are visible on the wire for JSON encoding. ## Experiments