diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-21 11:54:28 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-21 11:54:28 +0000 |
commit | e6918187568dbd01842d8d1d2c808ce16a894239 (patch) | |
tree | 64f88b554b444a49f656b6c656111a145cbbaa28 /src/jaegertracing/opentelemetry-cpp/third_party/opentelemetry-proto/README.md | |
parent | Initial commit. (diff) | |
download | ceph-e6918187568dbd01842d8d1d2c808ce16a894239.tar.xz ceph-e6918187568dbd01842d8d1d2c808ce16a894239.zip |
Adding upstream version 18.2.2.upstream/18.2.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/jaegertracing/opentelemetry-cpp/third_party/opentelemetry-proto/README.md')
-rw-r--r-- | src/jaegertracing/opentelemetry-cpp/third_party/opentelemetry-proto/README.md | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/src/jaegertracing/opentelemetry-cpp/third_party/opentelemetry-proto/README.md b/src/jaegertracing/opentelemetry-cpp/third_party/opentelemetry-proto/README.md new file mode 100644 index 000000000..0b88f5077 --- /dev/null +++ b/src/jaegertracing/opentelemetry-cpp/third_party/opentelemetry-proto/README.md @@ -0,0 +1,57 @@ +# Language Independent Interface Types For OpenTelemetry + +[![Build Check](https://github.com/open-telemetry/opentelemetry-proto/workflows/Build%20Check/badge.svg?branch=main)](https://github.com/open-telemetry/opentelemetry-proto/actions?query=workflow%3A%22Build+Check%22+branch%3Amain) + +The proto files can be consumed as GIT submodules or copied and built directly in the consumer project. + +The compiled files are published to central repositories (Maven, ...) from OpenTelemetry client libraries. + +See [contribution guidelines](CONTRIBUTING.md) if you would like to make any changes. + +## Generate gRPC Client Libraries + +To generate the raw gRPC client libraries, use `make gen-${LANGUAGE}`. Currently supported languages are: + +* cpp +* csharp +* go +* java +* objc +* openapi (swagger) +* php +* python +* ruby + +## Maturity Level + +Component | Maturity | +-------------------------------------|----------| +**Binary Protobuf Encoding** | | +common/* | Stable | +metrics/\*<br>collector/metrics/* | Stable | +resource/* | Stable | +trace/trace.proto<br>collector/trace/* | Stable | +trace/trace_config.proto | Alpha | +logs/\*<br>collector/logs/* | Beta | +**JSON encoding** | | +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 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 a 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, +we recommend using an "experimental" sub-directory instead of adding them to any +protocol version. These protocols should not be used, except for +development/testing purposes. + +Another review must be conducted for experimental protocols to join the main project. |