open-telemetry / opentelemetry-proto

OpenTelemetry Protocol (OTLP) Specification This repository contains the OTLP protocol specification and the corresponding Language Independent Interface Types (.proto files). Language Independent Interface Types 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 if you would like to make any changes. OTLP/JSON See additional requirements for OTLP/JSON wire representation here. Generate gRPC Client Libraries To generate the raw gRPC client libraries, use . Currently supported languages are: • cpp • csharp • go • java • objc • openapi (swagger) • php • python • ruby Maturity Level 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 | | resource/* | Stable | Stable | | metrics/\* collector/metrics/* | Stable | Stable | | trace/\* collector/trace/* | Stable | Stable | | logs/\* collector/logs/* | Stable | Stable | | profiles/\* collector/profiles/* | Development | Development | (See Versioning and Stability for definition of maturity levels). Stability Definition Components marked provide the following guarantees: • Field types, numbers and names will not change. • Service names and package names will not change. • Service method names will not change. [from 1.0.0] • Service method parameter names will not change. [from 1.0.0] • Service method parameter types and return types will not change. [from 1.0.0] • Service method kind (unary vs streaming) will not change. • Names of s and s will not change. [from 1.0.0] • Numbers assigned to choices will not change. • Names of choices will not change. [from 1.0.0] • The location of s and s, i.e. whether they are declared at the top lexical scope or nested inside another will not change. [from 1.0.0] • Package names and directory structure will not change. [from 1.0.0] • and declarators of existing fields will not change. [from 1.0.0] • No existing symbol will be deleted. [from 1.0.0] Note: guarantees marked [from 1.0.0] will go into effect when this repository is tagged with version number 1.0.0. The following additive changes are allowed: • Adding new fields to existing s. • Adding new s or s. • Adding new choices to existing s. • Adding new choices to existing fields. • Adding new s. • Adding new s to existing s. All the additive changes above must be accompanied by an explanation about how new and old senders and receivers that implement the version of the protocol before and after the change interoperate. Experiments New Experimental Components Sometimes we need to experiment with new components, for example to add a completely new signal to OpenTelemetry. When designing a new signal, we recommend a "development" package to be used. This package will be used throughout development until reaching release candidate, in which case the suffix is removed (e.g. instead of ), creating a stable release package. Such isolated experimental components are excluded from above stability requirements. We recommend using , , , levels to communicate different grades of readiness of new components. These levels MUST be communicated in the documentation of a message, field, etc. when the level does not match the stability of the package. For example, if a package is but a field is not, the documentation MUST indicate that the field is experimental with the appropriate level (e.g. , , etc). Conversely, individual annotations are not required if a component is the same maturity level as the package it is defined in. Experimental components may be removed completely at the end of the experiment, provided that they are not referenced from any component. Experiments which succeed, require a review to be marked . Once marked they become subject to the stability requirements. Experimental Additions to Stable Components New experimental fields or messages may be added in state to components. The experimental fields and messages within are subject to the full stability requirements. When the stability of a *portion* of the protocol doesn't match the expectations of the package, there MUST be a stability annotation in the docs. For example: If an experiment concludes and the previously added field or message is not needed anymore, the field/message must stay, but it may be declared "deprecated". During all phases of experimentation it must be clearly specified that the field or message may be deprecated. Typically, deprecated fields are left empty by the senders and the recipients that participate in experiments must expect during all experimental phases (including *after* the experiment is concluded) that the experimental field or message has an empty value. Experiments which succeed, require a review before the field or the message is marked . Generated Code No guarantees are provided whatsoever about the stability of the code that is generated from the .proto files by any particular code generator. Maintainers • OpenTelemetry Technical Committee For more information about the maintainer role, see the community repository. Approvers • OpenTelemetry Specification Sponsors For more information about the approver role, see the community repository.