contrib

README

OpenTelemetry-Go Contrib

Collection of 3rd-party packages for OpenTelemetry-Go.

Contents

• Instrumentation: Packages providing OpenTelemetry instrumentation for 3rd-party libraries.
• Propagators: Packages providing OpenTelemetry context propagators for 3rd-party propagation formats.
• Detectors: Packages providing OpenTelemetry resource detectors for 3rd-party cloud computing environments.
• Samplers: Packages providing additional implementations of OpenTelemetry samplers.

Project Status

This project is currently in a pre-GA phase. Our progress towards a GA release candidate is tracked in this project board.

Compatibility

OpenTelemetry-Go Contrib ensures compatibility with the current supported versions of the Go language:

Each major Go release is supported until there are two newer major releases. For example, Go 1.5 was supported until the Go 1.7 release, and Go 1.6 was supported until the Go 1.8 release.

For versions of Go that are no longer supported upstream, opentelemetry-go-contrib will stop ensuring compatibility with these versions in the following manner:

• A minor release of opentelemetry-go-contrib will be made to add support for the new supported release of Go.
• The following minor release of opentelemetry-go-contrib will remove compatibility testing for the oldest (now archived upstream) version of Go. This, and future, releases of opentelemetry-go-contrib may include features only supported by the currently supported versions of Go.

This project is tested on the following systems.

OS	Go Version	Architecture
Ubuntu	1.19	amd64
Ubuntu	1.18	amd64
Ubuntu	1.19	386
Ubuntu	1.18	386
MacOS	1.19	amd64
MacOS	1.18	amd64
Windows	1.19	amd64
Windows	1.18	amd64
Windows	1.19	386
Windows	1.18	386

While this project should work for other systems, no compatibility guarantees are made for those systems currently.

Contributing

For information on how to contribute, consult the contributing guidelines

Documentation

Overview

Package contrib is a collection of extensions for the opentelemetry-go project. It provides 3rd parth resource detectors, propagators, samplers, and instrumentation as submodules.

Package contrib contains common values used across all instrumentation, exporter, and detector contributions.

Index

• func SemVersion() string
• func Version() string

Functions

func SemVersion

func SemVersion() string

SemVersion is the semantic version to be supplied to tracer/meter creation.

func Version

func Version() string

Version is the current release version of OpenTelemetry Contrib in use.