Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update updating OpenTelemetry Collector dependencies doc #2049

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Update updating OpenTelemetry Collector dependencies doc #2049

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d6985a5
Update updating OpenTelemetry Collector dependencies doc
wildum Nov 6, 2024
04e8660
Update docs/developer/updating-otel/README.md
wildum Nov 8, 2024
6ce6a29
Update docs/developer/updating-otel/README.md
wildum Nov 8, 2024
60c774a
Update docs/developer/updating-otel/README.md
wildum Nov 8, 2024
29ff7e9
Update docs/developer/updating-otel/README.md
wildum Nov 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/developer/updating-otel/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,18 @@ Unfortunately, updating Otel dependencies is not straightforward:
You can refer to [PR grafana/agent#5290](https://github.com/grafana/agent/pull/5290)
for an example on how to update Alloy.

### Notify community component contributors

You can find the community contributor GitHub handles at the top of the community component files (the components that have "Community" set to true).
Once the PR is created, you can ping them in the PR and message them on Slack. Each contributor should create a PR in your branch with the updated component.
Notify the contributors a few days before the release so they have enough time to do the update.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most of the time when you read these docs you will be doing the release, so I'm not sure if it's the right place for a reminder like this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is the "updating-otel" doc. The update should be done prior to the release and should be started at least one week before cutting the RC

It should not be a blocker for the release. If the contributors can't do the update, you can fix the code to resolve the breaking changes or disable the component if that's too complicated.

### Check for metric updates

Some Otel metrics are used in the k8s monitoring helm chart and in integrations.
Make sure to update this [list](https://github.com/grafana/k8s-monitoring-helm/blob/main/charts/k8s-monitoring-v1/default_allow_lists/alloy_integration.yaml) if any of these metrics has been removed or renamed.

## Testing

### Testing a tracing pipeline locally
Expand Down