Skip to content

Latest commit

 

History

History
42 lines (34 loc) · 2.47 KB

upgrade-opentelemetry.md

File metadata and controls

42 lines (34 loc) · 2.47 KB
Raw

Upgrade OpenTelemetry

When the opentelemetry-collector and opentelemetry-collector-contrib repos do a release, we need to update our dependencies to pick up the new changes.

Update All Dependencies

There is a make target to update all OpenTelemetry dependencies and regenerate necessary metadata. To run the update:

make update-opentelemetry
update-opentelemetry target details --> First, you will need to manually fetch the release candidate tags for the stable `go.opentelemetry.io` modules. Since their latest release tags are not in sync with everything else (see [this open issue](open-telemetry/opentelemetry-collector#8063)) you will have to manually fetch these to get the tag for the same ref as the other dependencies. You will find some `grep -v` commands in the `update-components` make target, those will be the versions where you'll need to manually fetch the release candidate tag instead. Failure to do this can cause issues in dependency resolution and automatically downgrade dependencies you are trying to upgrade.

Next, update all OpenTelemetry dependencies to the newest possible version.

make update-components

These dependencies include the mdatagen tool, which is in a separate place from libraries (read more in tools.md). Since the mdatagen version has been updated in the tools go.mod, re-install tools to actually install the new version:

make install-tools

With the new version of mdatagen installed, regenerate the metadata packages for tests. This will bring the test packages in line with anything that's changed in the opentelemetry-collector base libraries.

GO_BUILD_TAGS=gpu make generate

Test

Updating OpenTelemetry dependencies and regenerating metadata frequently includes breaking changes in the foundational libraries like pdata that require changes to our receivers and tests. Start by ensuring it is possible to build:

GO_BUILD_TAGS=gpu make build

Fix any build errors that may come with the dependency upgrade, then ensure tests also pass:

GO_BUILD_TAGS=gpu make test

Once the upgrade is complete and build and test are healthy, submit a PR with your changes. Ensure the new OpenTelemetry Collector version is within the PR title, so we can keep track of when we made each upgrade.