-
Notifications
You must be signed in to change notification settings - Fork 2
feat: add logging levels to controlplane-operator #81
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
Draft
tscrond
wants to merge
7
commits into
patrostkowski:main
Choose a base branch
from
tscrond:feature/improve-logging
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
d799650
feat: add logging levels to controlplane-operator
tscrond 694f39f
fix: change default log level to info
tscrond 9505879
fix: revert the CRD bump
tscrond 9c73347
fix: comment update-crds script in taskfile
tscrond c93cf87
fix: add panic when logLevel not recognized
tscrond 07a2acb
feat: add logger abstraction according to PR comment
tscrond fd85833
fix: revert the taskfile change
tscrond File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| // Copyright 2025 Patryk Rostkowski | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package logger | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| "github.com/go-logr/logr" | ||
| ) | ||
|
|
||
| type Level int | ||
|
|
||
| const ( | ||
| DebugLevel Level = iota | ||
| InfoLevel | ||
| WarnLevel | ||
| ErrorLevel | ||
| None | ||
| ) | ||
|
|
||
| type Logger interface { | ||
| Debug(msg string, keysAndValues ...any) | ||
| Info(msg string, keysAndValues ...any) | ||
| Warn(msg string, keysAndValues ...any) | ||
| Error(err error, msg string, keysAndValues ...any) | ||
| GetBaseLogrInstance() logr.Logger | ||
| } | ||
|
|
||
| func ParseLogLevel(parsedLogLevel string) (Level, error) { | ||
| switch parsedLogLevel { | ||
| case "debug": | ||
| return DebugLevel, nil | ||
| case "info": | ||
| return InfoLevel, nil | ||
| case "warn": | ||
| return WarnLevel, nil | ||
| case "error": | ||
| return ErrorLevel, nil | ||
| default: | ||
| return None, fmt.Errorf("log level %s is not defined", parsedLogLevel) | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| // Copyright 2025 Patryk Rostkowski | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package logger | ||
|
|
||
| import ( | ||
| "github.com/go-logr/logr" | ||
| "go.uber.org/zap/zapcore" | ||
| "sigs.k8s.io/controller-runtime/pkg/log/zap" | ||
| ) | ||
|
|
||
| type ZapLogger struct { | ||
| log logr.Logger | ||
| } | ||
|
|
||
| func NewZapLogger(logLevel Level) *ZapLogger { | ||
| newZap := zap.New(zap.UseDevMode(true), zap.Level(logLevel.toZapLevel())) | ||
| return &ZapLogger{ | ||
| log: newZap, | ||
| } | ||
| } | ||
|
|
||
| func (l Level) toZapLevel() zapcore.Level { | ||
| switch l { | ||
| case DebugLevel: | ||
| return zapcore.DebugLevel | ||
| case InfoLevel: | ||
| return zapcore.InfoLevel | ||
| case WarnLevel: | ||
| return zapcore.WarnLevel | ||
| case ErrorLevel: | ||
| return zapcore.ErrorLevel | ||
| default: | ||
| return zapcore.InfoLevel | ||
| } | ||
| } | ||
|
|
||
| func (l *ZapLogger) GetBaseLogrInstance() logr.Logger { | ||
| return l.log | ||
| } | ||
|
|
||
| func (l *ZapLogger) Debug(msg string, kv ...any) { | ||
| l.log.V(int(zapcore.DebugLevel)).Info(msg, kv...) | ||
| } | ||
|
|
||
| func (l *ZapLogger) Info(msg string, kv ...any) { | ||
| l.log.V(int(zapcore.InfoLevel)).Info(msg, kv...) | ||
| } | ||
|
|
||
| func (l *ZapLogger) Warn(msg string, kv ...any) { | ||
| l.log.V(int(zapcore.WarnLevel)).Info(msg, kv...) | ||
| } | ||
| func (l *ZapLogger) Error(err error, msg string, kv ...any) { | ||
| l.log.V(int(zapcore.ErrorLevel)).Error(err, msg, kv...) | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To keep things tidy, lets not expose users to setting the log levels using arbitrary numbers and instead implement an interface that could allow us to call
log.Info/Debug/Warn/Errorinstead. something likeand under the hood we should just map it like:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't know if this is the exact thing you were aiming for in this comment, but i think it's pretty accurate.
07a2acb