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.

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

Add docs for updating Otel dependencies #4343

Merged
merged 4 commits into from
Oct 12, 2023
Merged

Conversation

ptodev
Copy link
Contributor

@ptodev ptodev commented Jul 5, 2023

Putting in writing the lessons learned from #3858. Hopefully this helps us to do upgrades more often and with less effort.

@ptodev ptodev requested a review from a team as a code owner July 5, 2023 12:39
@ptodev ptodev force-pushed the upgrade-otel-dev-guilde branch from edbbc2b to 9ab8816 Compare July 5, 2023 12:40
Copy link
Member

@rfratto rfratto left a comment

Choose a reason for hiding this comment

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

Rubber stamp; I don't personally have time to dive deep into this, but I don't want you to be blocked on getting docs merged. We can improve them over time.

@ptodev
Copy link
Contributor Author

ptodev commented Aug 31, 2023

Rubber stamp; I don't personally have time to dive deep into this, but I don't want you to be blocked on getting docs merged. We can improve them over time.

@rfratto thank you, but based on your comment on another PR, I think the section on labeling the stability will have to be changed:

  1. Update the Agent's code and documentation where needed.
    * Pay particular attention to whether the component's stability has changed. Stability is labeled at the top of the Collector documentation. The stability label in Collector's docs should match the one in the Agent's docs.

When someone updates the components, they need to know whether the stability label in the Agent docs is accurate. I'm not sure what is the best way to do this right now? E.g. some components which are beta in Collector might be stable in the Agent, etc.

@ptodev ptodev requested a review from rfratto September 1, 2023 20:19
@rfratto
Copy link
Member

rfratto commented Sep 7, 2023

The stability level can always be increased but should never be decreased. We should be extra cautious when introducing new components. If we introduce it as stable, it's stable.

@ptodev
Copy link
Contributor Author

ptodev commented Oct 6, 2023

@rfratto Thank you - I updated the instructions to say that stability lebels should never be decreased. Now they also say that if a stability in Otel has increased, the developer should check with the rest of the team on whether the Agent component's stability should also be increased.

@wildum Would you mind reviewing the documentation please? I updated it just now to reflect some of the points we discussed on the PR.

docs/developer/updating-otel.md Outdated Show resolved Hide resolved
docs/developer/updating-otel.md Outdated Show resolved Hide resolved
@ptodev ptodev force-pushed the upgrade-otel-dev-guilde branch from 33002b7 to 313e6a3 Compare October 11, 2023 16:50
@ptodev ptodev requested a review from wildum October 11, 2023 16:50
@ptodev ptodev force-pushed the upgrade-otel-dev-guilde branch from 313e6a3 to 2c7c31f Compare October 12, 2023 23:00
@ptodev ptodev merged commit 4e35d2b into main Oct 12, 2023
@ptodev ptodev deleted the upgrade-otel-dev-guilde branch October 12, 2023 23:29
@github-actions github-actions bot added the frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed. label Feb 21, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants