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

✨ Allow panic as an option to -zap-stacktrace-level" #1348

Merged
merged 1 commit into from
Jan 22, 2021
Merged

✨ Allow panic as an option to -zap-stacktrace-level" #1348

merged 1 commit into from
Jan 22, 2021

Conversation

croomes
Copy link
Contributor

@croomes croomes commented Jan 20, 2021

This allows stack trace logging to be disabled for all but panic log entries.

The Zap DisableStackTrace config parameter (https://github.com/uber-go/zap/blob/master/config.go#L72) isn't available via the Option interface, so it's not possible (or at least I couldn't find a way) to disable it completely via a user-added flag.

Closes #1035

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jan 20, 2021
@k8s-ci-robot
Copy link
Contributor

Welcome @croomes!

It looks like this is your first PR to kubernetes-sigs/controller-runtime 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/controller-runtime has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

Hi @croomes. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jan 20, 2021
@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jan 20, 2021
@croomes croomes changed the title :sparkles Allow panic as an option to -zap-stacktrace-level" ✨ Allow panic as an option to -zap-stacktrace-level" Jan 20, 2021
@croomes croomes mentioned this pull request Jan 20, 2021
Merged
@coderanger
Copy link
Contributor

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Jan 20, 2021
@croomes
Copy link
Contributor Author

croomes commented Jan 20, 2021 •
edited
Loading

/retest

@croomes
Copy link
Contributor Author

croomes commented Jan 20, 2021

/test pull-controller-runtime-test-master

Looks like un unrelated flake: "race detected during execution of test" in:
sigs.k8s.io/controller-runtime/pkg/manager

alvaroaleman
alvaroaleman reviewed Jan 21, 2021
View reviewed changes
pkg/log/zap/zap_test.go
out := Options{}
UseFlagOptions(&fromFlags)(&out)

Expect(out.StacktraceLevel.Enabled(zapcore.PanicLevel)).To(BeTrue())
Copy link
Member

Choose a reason for hiding this comment

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

Isn't the more important test that its disabled on the next level, i.E. error?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added disable check for info and error.

@croomes
Allow panic as an option to -zap-stacktrace-level"
9b98559 
This allows stack traces to be disabled for all but panic log entries.

The Zap library doesn't have an option to completely disable stack
traces.
@croomes croomes force-pushed the stack-trace-levels branch from 5d4651a to 9b98559 Compare January 22, 2021 11:40
alvaroaleman
alvaroaleman approved these changes Jan 22, 2021
View reviewed changes
Copy link
Member

@alvaroaleman alvaroaleman left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

thanks!

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 22, 2021
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alvaroaleman, croomes

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 22, 2021
@k8s-ci-robot k8s-ci-robot merged commit 9e78e65 into kubernetes-sigs:master Jan 22, 2021
@croomes croomes deleted the stack-trace-levels branch February 26, 2021 19:57
This was referenced Mar 9, 2021
Closed
Closed
Open
Closed
Closed
Closed
This was referenced Mar 11, 2021
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Open
Closed
Closed
Open
Open
Closed
Closed
@dependabot dependabot bot mentioned this pull request Mar 18, 2021
Closed
@dhaiducek dhaiducek mentioned this pull request Oct 13, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alvaroaleman alvaroaleman alvaroaleman approved these changes

@alenkacz alenkacz Awaiting requested review from alenkacz

@pwittrock pwittrock Awaiting requested review from pwittrock

Assignees

@alvaroaleman alvaroaleman

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add option to disable stack traces for zap logs --zap-stacktrace-level
4 participants
@croomes @k8s-ci-robot @coderanger @alvaroaleman