Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: William Dumont <[email protected]>
  • Loading branch information
ptodev and wildum committed Oct 12, 2023
1 parent 41925ea commit 2c7c31f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/developer/updating-otel.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Unfortunately, updating Otel dependencies is not straightforward:

### Update the Grafana fork of Otel Collector

1. Create a new release branch with a `-grafana` suffix under [grafana/opentelemetry-collector](https://github.com/grafana/opentelemetry-collector). For example, if porting branch `v0.86.0`, make a branch under the fork repo called `0.86-grafana`.
1. Create a new release branch from the [opentelemetry release branch](https://github.com/open-telemetry/opentelemetry-collector) with a `-grafana` suffix under [grafana/opentelemetry-collector](https://github.com/grafana/opentelemetry-collector). For example, if porting branch `v0.86.0`, make a branch under the fork repo called `0.86-grafana`.
2. Check which branch of the fork repo the Agent currently uses.
3. See what commits were pushed onto that branch to customize it.
4. Create a PR to cherry-pick the same commits to the new branch. See the [changes to the 0.85 branch](https://github.com/grafana/opentelemetry-collector/pull/8) for an example PR.
Expand All @@ -47,7 +47,7 @@ Unfortunately, updating Otel dependencies is not straightforward:
```
go mod edit -replace=go.opentelemetry.io/collector=github.com/grafana/opentelemetry-collector@asdf123jkl
```
Repeat this for any other modules where a replacement is necessary.
Repeat this for any other modules where a replacement is necessary. For debugging purposes, you can first have the replace directive pointing to your local repo.
3. Note that sometimes Collector depends on packages with "rc" versions such as `v1.0.0-rcv0013`. This is ok, as long as the go.mod of Collector also references the same versions - for example, [pdata](https://github.com/open-telemetry/opentelemetry-collector/blob/v0.81.0/go.mod#L25) and [featuregate](https://github.com/open-telemetry/opentelemetry-collector/blob/v0.81.0/go.mod#L24).

### Update otelcol Flow components
Expand Down

0 comments on commit 2c7c31f

Please sign in to comment.