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.

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 attempts to track the current supported versions of the Go language. The release schedule after a new minor version of go is as follows:

• The first release or one month, which ever is sooner, will add build steps for the new go version.
• The first release after three months will remove support for the oldest go version.

This project is tested on the following systems.

OS	Go Version	Architecture
Ubuntu	1.18	amd64
Ubuntu	1.17	amd64
Ubuntu	1.16	amd64
Ubuntu	1.18	386
Ubuntu	1.17	386
Ubuntu	1.16	386
MacOS	1.18	amd64
MacOS	1.17	amd64
MacOS	1.16	amd64
Windows	1.18	amd64
Windows	1.17	amd64
Windows	1.16	amd64
Windows	1.18	386
Windows	1.17	386
Windows	1.16	386

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

Go 1.18 was added in March of 2022. Go 1.16 will be removed around June 2022.

Contributing

For information on how to contribute, consult the contributing guidelines

Documentation

Overview

This package provides all of its functionality through its submodules. The submodules in the exporters directory provide implementations for trace and metric exporters for third-party collectors, and submodules in the instrumentation directory provide the instrumentation for the popular go libraries.

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.