shoalsoft-pants-opentelemetry-plugin 0.6.0.dev0

Pantsbuild OpenTelemetry Plugin from Shoal Software LLC

Pantsbuild OpenTelemetry Plugin

[!IMPORTANT] This plugin only supports Pants v2.32 due to Pants switching to Python 3.14 for its internal Python version. Moreover, the new pants.backend.observability.backend in Pants v2.33 (based on this plugin) makes this plugin no longer necessary with Pants v2.33 and later versions.

Installation

From PyPI:

1. In the relevant Pants project, edit pants.toml to set the [GLOBAL].plugins option to include shoalsoft-pants-opentelemetry-plugin and the [GLOBAL].backend_packages option to include shoalsoft.pants_opentelemetry_plugin.

2. For basic export to a local OpenTelemetry collector agent on its default port, configure the plugin as follows in pants.toml:

   [shoalsoft-opentelemetry]
   enabled = true
   

3. The plugin exposes many other options (which correspond to OTEL_ environment variables in other systems). Run pants help-advanced shoalsoft-opentelemetry to see all of the plugin's available configuration options.

Note: The plugin respects any TRACEPARENT environment variable and will link generated traces to the parent trace and span referenced in the TRACEPARENT.