Categorygithub.com/open-telemetry/opentelemetry-collector-contrib/extension/encoding
modulepackage
0.121.0
Repository: https://github.com/open-telemetry/opentelemetry-collector-contrib.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
5
Dependents
8
Files
39 SLOC

# README

Encoding extensions

The encoding extensions can be used by compatible receivers or exporters to encode or decode data into/from a specific format. This is useful when the data is being sent to/from a system that expects a specific format and doesn't support the OpenTelemetry protocol.

🚧 Under active development 🚧

Component Milestones

To help track what work needs to be done with this component, these are the currently active goals being worked towards.

Development

  • Add encoding extensions support additionally to the existing ways of configuring encodings (where applicable) to the following components:
    • file receiver
    • file exporter
    • kafka receiver
    • kafka exporter
    • kinesis exporter
    • pulsar receiver
    • pulsar exporter
  • Add encoding extensions for open source formats, ie: otlp, zipkin, jaeger
  • Deprecate the previously available ways of configuring encodings (where applicable).
  • Remove the previously available ways of configuring encodings in favour of using the encoding extension.

Example configuration

extensions:
  zipkin_encoding:
    protocol: zipkin_proto
    version: v2

receivers:
  kafka:
    encoding: zipkin_encoding
    # ... other configuration values

# Packages

go:generate mdatagen metadata.yaml.
go:generate mdatagen metadata.yaml.
go:generate mdatagen metadata.yaml.
go:generate mdatagen metadata.yaml.
go:generate mdatagen metadata.yaml.
No description provided by the author
go:generate mdatagen metadata.yaml.
go:generate mdatagen metadata.yaml.

# Interfaces

LogsMarshalerExtension is an extension that marshals logs.
LogsUnmarshalerExtension is an extension that unmarshals logs.
MetricsMarshalerExtension is an extension that marshals metrics.
MetricsUnmarshalerExtension is an extension that unmarshals metrics.
ProfilesMarshalerExtension is an extension that marshals profiles.
ProfilesUnmarshalerExtension is an extension that unmarshals Profiles.
TracesMarshalerExtension is an extension that marshals traces.
TracesUnmarshalerExtension is an extension that unmarshals traces.