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

Create a must-gather for the operator #3150

Merged
merged 57 commits into from
Oct 7, 2024

Conversation

iblancasa
Copy link
Contributor

@iblancasa iblancasa commented Jul 18, 2024

Description: adds must-gather tool for troubleshooting.

I created it using Golang so we can add it directly to the operator container image.

@iblancasa iblancasa changed the title [chore] Fix bundle image build Create a must-gather for the operator Jul 18, 2024
Signed-off-by: Israel Blancas <iblancasa@gmail.com>
Signed-off-by: Israel Blancas <iblancasa@gmail.com>
Signed-off-by: Israel Blancas <iblancasa@gmail.com>
@iblancasa iblancasa marked this pull request as ready for review July 26, 2024 10:36
@iblancasa iblancasa requested a review from a team July 26, 2024 10:36
.chloggen/3149-add-must-gather.yaml Outdated Show resolved Hide resolved
.chloggen/3149-add-must-gather.yaml Outdated Show resolved Hide resolved
cmd/gather/main.go Show resolved Hide resolved
Dockerfile Outdated Show resolved Hide resolved
cmd/gather/README.md Show resolved Hide resolved
Signed-off-by: Israel Blancas <iblancasa@gmail.com>
@iblancasa iblancasa requested a review from a team as a code owner September 19, 2024 13:03
Copy link
Contributor

@swiatekm swiatekm left a comment

Choose a reason for hiding this comment

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

I'm fine with this PR as is, and this kind of tool doesn't really need extensive testing. But I would like to have some assurance that it actually works on a basic level. Is there some kind of E2E test we could do to verify that?

Signed-off-by: Israel Blancas <iblancas@redhat.com>
@iblancasa
Copy link
Contributor Author

iblancasa commented Sep 26, 2024

I'm fine with this PR as is, and this kind of tool doesn't really need extensive testing. But I would like to have some assurance that it actually works on a basic level. Is there some kind of E2E test we could do to verify that?

I added some unit tests and I think that should be enough. I'll ask for guidance from our QE expert to see if we can add some E2E tests but I think that can be done as part of a separate PR.

Copy link
Contributor

@swiatekm swiatekm left a comment

Choose a reason for hiding this comment

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

👍

Copy link
Member

@pavolloffay pavolloffay left a comment

Choose a reason for hiding this comment

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

a couple of nits and a question

.github/workflows/publish-must-gather.yaml Outdated Show resolved Hide resolved
.chloggen/3149-add-must-gather.yaml Outdated Show resolved Hide resolved
.chloggen/3149-add-must-gather.yaml Outdated Show resolved Hide resolved
.github/workflows/publish-must-gather.yaml Show resolved Hide resolved
.github/workflows/publish-must-gather.yaml Outdated Show resolved Hide resolved
cmd/gather/README.md Outdated Show resolved Hide resolved
cmd/gather/README.md Outdated Show resolved Hide resolved
if err != nil {
log.Fatalln(err)
}
err = cluster.GetOpenTelemetryCollectors()
Copy link
Member

Choose a reason for hiding this comment

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

Does it add collector logs?

Copy link
Contributor Author

@iblancasa iblancasa Oct 2, 2024

Choose a reason for hiding this comment

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

Just the collector. If you want, I can also add the collector logs but I would prefer to add it as part of a new PR. Otherwise, we will never merge this one.

Copy link
Member

Choose a reason for hiding this comment

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

Please do in a follow up PR

@iblancasa
Copy link
Contributor Author

@pavolloffay I addressed your comments. Is this ok to merge?

Copy link
Member

@pavolloffay pavolloffay left a comment

Choose a reason for hiding this comment

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

just a nit for changelog

change_type: enhancement

# The name of the component, or a single word describing the area of concern, (e.g. collector, target allocator, auto-instrumentation, opamp, github action)
component: instrumentation, collector
Copy link
Member

Choose a reason for hiding this comment

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

auto-instrumentation

if err != nil {
log.Fatalln(err)
}
err = cluster.GetOpenTelemetryCollectors()
Copy link
Member

Choose a reason for hiding this comment

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

Please do in a follow up PR

@pavolloffay pavolloffay merged commit e84193d into open-telemetry:main Oct 7, 2024
33 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create a must-gather for the Operator
4 participants