Skip to content

Protobuf definitions for the OpenTelemetry protocol (OTLP)

License

Notifications You must be signed in to change notification settings

victlu/opentelemetry-proto

 
 

Repository files navigation

Language Independent Interface Types For OpenTelemetry

Build Check

The proto files can be consumed as GIT submodule or copied over and built directly in the consumer project.

The compiled files are published to central repositories (Maven, NPM...) from OpenTelemetry client libraries.

See contribution guidelines if you would like to make any changes.

Generate gRPC Client Libraries

To generate the raw gRPC client libraries use make gen-${LANGUAGE}. Current supported languages are:

  • cpp
  • csharp
  • go
  • java
  • objc
  • openapi (swagger)
  • php
  • python
  • ruby

Maturity Level

Component Maturity
Binary Protobuf Encoding
collector/metrics/* Stable
collector/trace/* Stable
collector/logs/* Alpha
common/* Stable
metrics/* Stable
resource/* Stable
trace/trace.proto Stable
trace/trace_config.proto Alpha
logs/* Alpha
JSON encoding
All messages Alpha

(See maturity-matrix.yaml 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 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.

About

Protobuf definitions for the OpenTelemetry protocol (OTLP)

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Makefile 100.0%