Development

March 27, 2026 · View on GitHub

Initial Setup

Clone this repository, and run make install-tools

Building

To create a build for your current machine, run make agent

To build for a specific architecture, see the Makefile

To build all targets, run make build-all

Build files will show up in the ./dist directory

Running CI checks locally

The CI runs the ci-checks make target, which includes linting, testing, and checking documentation for misspelling. CI also does a build of all targets (make build-all)

Updating to latest OTEL version

Read through the release notes for the versions of contrib and core that are being updated to. If doing multiple versions look at all version included, i.e. if going from v0.120.0 to v0.122.0 look at v0.121.0 as well. Look for any potential deprecations or breaking changes that could affect Bindplane resources (these are typically in the "End User Changelog" but check the "API Changelog" as well).

If there are any potential issues with the update, raise concerns in the team channel and coordinate an update plan if necessary.

Most of the process for updating the OTEL dependency is automated with scripts. If at any point there is a failure, try running make tidy to see if updating the go.mod is able to resolve the issue. The steps are as follows:

Run:
```
./scripts/update-otel.sh {COLLECTOR_VERSION} {CONTRIB_VERSION} {PDATA_VERSION}
```
Grab the different versions from OTEL's GitHub by checking the latest release versions of collector-contrib and the collector. They should be the same. The pdata version can be found by checking the latest release notes of the collector in a header with {PDATA_VERSION}/{COLLECTOR_VERSION}. All three version arguments should include the v - an example run of the script would look like this:
```
./scripts/update-otel.sh v0.114.0 v0.114.0 v1.20.0
```
Run make tidy
Run:
```
./scripts/update-docs.sh {COLLECTOR_VERSION} {CONTRIB_VERSION} {BDOT_CONTRIB_VERSION}
```
The collector and contrib versions should be the same as in step 1. The BDOT_CONTRIB_VERSION is the latest release version of bindplane-otel-contrib.
Run make install-tools
Run make generate
Run make tidy
Run make ci-checks

If all was successful, the repo has had its OTEL dependencies updated to the latest version.

There is potential for tests to fail, deprecation issues, code changes, or a variety of other problems to arise, but once the above steps are successful the repo can be updated.

Updating bindplane-otel-contrib dependencies

When bindplane-otel-contrib publishes a new release, update the Go module dependencies in this repo:

Run:
```
make update-contrib BDOT_CONTRIB_VERSION=vx.x.x
```
where vx.x.x is the new version of bindplane-otel-contrib.
Run make ci-checks to verify the update.

Releasing

To release the agent, see releasing documentation.