contrib

These packages are Datadog's integrations for commonly used standard-library and community packages. Each one instruments a package in a "plug-and-play" manner: import the matching path and use the exposed functions, which mirror the original package's API and add tracing out of the box, with no need to create spans manually. Some integrations also add support for other Datadog products beyond APM, such as App and API Protection (AAP), Data Streams Monitoring (DSM), or Database Monitoring (DBM), and more.

These integrations are supported by our APM product.

Semantic conventions

Integrations can emit either Datadog or OpenTelemetry semantic conventions, configured by DD_TRACE_OTEL_SEMANTICS_ENABLED, with Datadog semantics being the default. New integrations should support and test both when applicable.

Using an integration

Each integration is a nested Go module, imported with the schema github.com/DataDog/dd-trace-go/contrib/<package path>/v2, where <package path> mirrors the instrumented package (for example net/http, gorilla/mux, google.golang.org/grpc). Check that integration's example_test.go for how to set it up and use it.

For the list of supported integrations, see the DataDog official documentation (supported integrations) and the godoc reference.

Contributing a new integration

See INTEGRATIONS.md for the full authoring guide, and ORCHESTRION.md for auto-instrumentation support via Orchestrion.

Version pinning

We aim to keep all integrated packages to their minimum working version without known vulnerabilities (based on reported CVEs). As integrated packages have different versioning policies regarding breaking changes, there is no guarantee that previously pinned versions will work with next dd-trace-go versions.

Deprecation

Integrations can be deprecated if all the following conditions are true:

• The integrated package is deprecated or archived (no longer maintained).
• A vulnerability is reported in the latest available version as CVE.