Connect OpenTelemetry Collectors Using the OpAMP Supervisor

This guide walks through building a custom OpenTelemetry Collector with the OpenTelemetry Collector Builder (OCB)arrow-up-right that includes Bindplane components and running it under the OpAMP Supervisorarrow-up-right so it can be remotely managed by Bindplane.

This approach is ideal when you want to:

  • Customize which receivers, processors, and exporters are compiled into your collector

  • Retain centralized configuration and lifecycle management through Bindplane

  • Experiment locally or deploy to VMs and bare-metal hosts

circle-exclamation

Prerequisites and Version Alignment

Before building anything, ensure all components use the same base OpenTelemetry Collector version.

Choose a base version

  1. Identify the OpenTelemetry Collector version used by the Bindplane Distribution of OpenTelemetry (BDOT).

  2. Use this version consistently across:

    • OpenTelemetry Collector Contrib

    • OpenTelemetry Collector Builder (OCB)

    • OpAMP Supervisor

    • All components referenced in your manifest

circle-info

NOTE

Some OpenTelemetry artifacts (such as OCB or the OpAMP Supervisor) may not be released for every collector version if no changes occurred. Always refer to the official OpenTelemetry Collector Releasesarrow-up-right for the correct versions.

Download the OpenTelemetry Collector Builder (OCB)

The OpenTelemetry Collector Builder generates a custom collector binary from a manifest file.

Requirements

Download

circle-info

NOTE

For more guidance view the OCB documentationarrow-up-right.

Create the Collector Manifest

Start with the standard OpenTelemetry Collector Contrib manifest and save it as manifest.yaml.

This file defines which components are compiled into your custom collector.

Add Bindplane Components to the Manifest

Update manifest.yaml to include the Bindplane extension and processors.

Extensions

Processors

Ensure the Bindplane component versions align with your selected collector version.

Distribution metadata

Complete manifest.yaml file sample

Build the Custom Collector

Run OCB with your manifest:

This produces a custom collector binary. This example will produce otelcol-contrib-bp since that is the value of dist.name in the manifest.yaml.

Download the OpAMP Supervisor

The OpAMP Supervisor is a standalone executable binary that manages the collector process and handles communication with Bindplane.

Download the OpAMP Supervisor binary that matches your collector version from the OpenTelemetry Collector Releasesarrow-up-right.

Configure the OpAMP Supervisor

Create a file named supervisor.yaml to configure the connection to Bindplane.

  • server.endpoint: Set the endpoint to the Bindplane OpAMP server.

  • server.headers.Authorization: Set the Authorization header using your Bindplane Secret Key.

  • agent.executable: Point the executable to the custom collector you built with OCB.

Optional: Enable local collector logging

To persist collector logs locally, reference an additional config file:

Create logging.yaml:

Run the Supervisor and Collector

Start the system by running the OpAMP Supervisor:

The supervisor will:

  • Launch your custom collector

  • Register it with Bindplane

  • Apply remote configuration updates automatically

Once connected, the collector appears in Bindplane and is fully managed through the platform.

Last updated

Was this helpful?