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

Reduce log verbosity #2455

Merged
merged 3 commits into from
Aug 22, 2024
Merged

Conversation

sjberman
Copy link
Contributor

Problem: NGF control plane logs are very verbose and give more information than is needed at the Info level.

Solution: Reduce many logs to the debug level, including logs from the controller-runtime library. Tests will log at the debug level.

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

Release notes

If this PR introduces a change that affects users and needs to be mentioned in the release notes,
please add a brief note that summarizes the change.

Reduced logging verbosity of default Info log level.

Problem: NGF control plane logs are very verbose and give more information than is needed at the Info level.

Solution: Reduce many logs to the debug level, including logs from the controller-runtime library. Tests will log at the debug level.
@sjberman sjberman requested a review from a team as a code owner August 22, 2024 18:27
@github-actions github-actions bot added the chore Pull requests for routine tasks label Aug 22, 2024
Copy link

codecov bot commented Aug 22, 2024

Codecov Report

Attention: Patch coverage is 50.00000% with 5 lines in your changes missing coverage. Please review.

Project coverage is 88.79%. Comparing base (6b146e6) to head (9f660eb).
Report is 1 commits behind head on main.

Files Patch % Lines
internal/mode/static/manager.go 0.00% 5 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2455      +/-   ##
==========================================
- Coverage   88.84%   88.79%   -0.05%     
==========================================
  Files         100      100              
  Lines        7527     7531       +4     
  Branches       50       50              
==========================================
  Hits         6687     6687              
- Misses        784      788       +4     
  Partials       56       56              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@bjee19 bjee19 left a comment

Choose a reason for hiding this comment

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

Are these code coverage checks fine to skip?

@sjberman
Copy link
Contributor Author

@bjee19 Yeah, we aren't testing logs.

@github-actions github-actions bot added the tests Pull requests that update tests label Aug 22, 2024
@sjberman sjberman enabled auto-merge (squash) August 22, 2024 20:44
@sjberman sjberman disabled auto-merge August 22, 2024 20:54
@sjberman sjberman enabled auto-merge (squash) August 22, 2024 22:01
@sjberman sjberman disabled auto-merge August 22, 2024 22:15
@sjberman sjberman enabled auto-merge (squash) August 22, 2024 22:18
@sjberman sjberman merged commit 2077bdb into nginx:main Aug 22, 2024
36 of 37 checks passed
@sjberman sjberman deleted the chore/reduce-log-verbosity branch August 22, 2024 22:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Pull requests for routine tasks tests Pull requests that update tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants