Skip to content
This repository has been archived by the owner on Oct 16, 2024. It is now read-only.

Latest commit

 

History

History
 
 

instrumentation

README.md

Instrumentation

Code contained in this directory contains instrumentation for 3rd-party Go packages and some packages from the standard library.

New Instrumentation

Do not submit pull requests for new instrumentation without reading the following.

This project is dedicated to promoting the development of quality instrumentation using OpenTelemetry. To achieve this goal, we recognize that the instrumentation needs to be written using the best practices of OpenTelemetry, but also by developers that understand the package they are instrumenting. Additionally, the produced instrumentation needs to be maintained and evolved.

The size of the OpenTelemetry Go developer community is not large enough to support an ever growing amount of instrumentation. Therefore, to reach our goal, we have the following recommendations for where instrumentation packages should live.

  1. Native to the instrumented package
  2. A dedicated public repository
  3. Here in the opentelemetry-go-contrib repository

If possible, OpenTelemetry instrumentation should be included in the instrumented package. This will ensure the instrumentation reaches all package users, and is continuously maintained by developers that understand the package.

If instrumentation cannot be directly included in the package it is instrumenting, it should be hosted in a dedicated public repository owned by its maintainer(s). This will appropriately assign maintenance responsibilities for the instrumentation and ensure these maintainers have the needed privilege to maintain the code.

The last place instrumentation should be hosted is here in this repository. Maintaining instrumentation here hampers the development of OpenTelemetry for Go and therefore should be avoided. When instrumentation cannot be included in a target package and there is good reason to not host it in a separate and dedicated repository an instrumentation request should be filed. The instrumentation request needs to be accepted before any pull requests for the instrumentation can be considered for merging.

Regardless of where instrumentation is hosted, it needs to be discoverable. The OpenTelemetry registry exists to ensure that instrumentation is discoverable. You can find out how to add instrumentation to the registry here.

Instrumentation Packages

The OpenTelemetry registry is the best place to discover instrumentation packages. It will include packages outside of this project.

The following instrumentation packages are provided for popular Go packages and use-cases.

Instrumentation Package Metrics Traces
github.com/aws/aws-sdk-go-v2 ✓
github.com/emicklei/go-restful ✓
github.com/gin-gonic/gin ✓
github.com/gorilla/mux ✓
github.com/labstack/echo ✓
go.mongodb.org/mongo-driver ✓
google.golang.org/grpc ✓ ✓
gopkg.in/macaron.v1 ✓
host ✓
net/http ✓ ✓
net/http/httptrace ✓
runtime ✓

Organization

In order to ensure the maintainability and discoverability of instrumentation packages, the following guidelines MUST be followed.

Packaging

All instrumentation packages SHOULD be of the form:

go.opentelemetry.io/contrib/instrumentation/{IMPORT_PATH}/otel{PACKAGE_NAME}

Where the {IMPORT_PATH} and {PACKAGE_NAME} are the standard Go identifiers for the package being instrumented.

For example:

  • go.opentelemetry.io/contrib/instrumentation/github.com/gorilla/mux/otelmux
  • go.opentelemetry.io/contrib/instrumentation/gopkg.in/macaron.v1/otelmacaron
  • go.opentelemetry.io/contrib/instrumentation/database/sql/otelsql

Exceptions to this rule exist. For example, the runtime and host instrumentation do not instrument any Go package and therefore do not fit this structure.

Contents

All instrumentation packages MUST adhere to the projects' contributing guidelines. Additionally the following guidelines for package composition need to be followed.

  • All instrumentation packages MUST be a Go module. Therefore, an appropriately configured go.mod and go.sum need to exist for each package.
  • To help understand the instrumentation a Go package documentation SHOULD be included. This documentation SHOULD be in a dedicated doc.go file if the package is more than one file. It SHOULD contain useful information like what the purpose of the instrumentation is, how to use it, and any compatibility restrictions that might exist.
  • Examples of how to actually use the instrumentation SHOULD be included.
  • All instrumentation packages MUST provide an option to accept a TracerProvider if it uses a Tracer, a MeterProvider if it uses a Meter, and Propagators if it handles any context propagation. Also, packages MUST use the default TracerProvider, MeterProvider, and Propagators supplied by the global package if no optional one is provided.
  • All instrumentation packages MUST NOT provide an option to accept a Tracer or Meter.
  • All instrumentation packages MUST define a ScopeName constant with a value matching the instrumentation package and use it when creating a Tracer or Meter.
  • All instrumentation packages MUST define a Version function returning the version of the module containing the instrumentation and use it when creating a Tracer or Meter.