Paketo Buildpack for OpenTelemetry

gcr.io/paketo-buildpacks/opentelemetry

The Paketo Buildpack for OpenTelemetry is a Cloud Native Buildpack that contributes and configures the OpenTelemetry Agent.

Behavior

This buildpack will participate if all the following conditions are met

• The $BP_OPENTELEMETRY_ENABLED is set to a truthy value (i.e. true, t, 1 ignoring case)

At build time, the buildpack will do the following for Java applications:

• Contributes the OpenTelemetry Java agent to a layer and configures $JAVA_TOOL_OPTIONS to use it.
• By default, the agent is configured to be disabled (OTEL_JAVAAGENT_ENABLED=false).
• By default, the logs exporting feature of the agent is configured to be disabled (OTEL_LOGS_EXPORTER=none).
• By default, the metrics exporting feature of the agent is configured to be disabled (OTEL_METRICS_EXPORTER=none).

At run time, the buildpack will do the following for Java applications:

• If a binding with type of opentelemetry exists, it uses the config tree from the binding to configure the OpenTelemetry Java agent. This is recommended when the configuration involves secrets of any kind.

Usage

Once you enable the OpenTelemetry buildpack at build-time, you can configure it at run-time via environment variables, as described in the project documentation or by passing configuration properties to the container via a binding.

By default, the following configuration is applied to the OpenTelemetry Java Agent at run time.

• OTEL_JAVAAGENT_ENABLED=false
• OTEL_LOGS_EXPORTER=none
• OTEL_METRICS_EXPORTER=none

When using a binding, key/values map directly to OpenTelemetry Java agent configuration properties. Keys can follow the environment variable format or the system property format, as described in the project documentation.

Bindings

The buildpack optionally accepts the following bindings:

Type: opentelemetry

Type: dependency-mapping

License

This buildpack is released under version 2.0 of the Apache License.