Add logging to sriov-cni #276
There are no files selected for viewing
This file contains 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 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 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 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 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 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 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,93 @@ | ||
| // package logging is a small wrapper around github.com/k8snetworkplumbingwg/cni-log | ||
|
|
||
| package logging | ||
|
|
||
| import ( | ||
| cnilog "github.com/k8snetworkplumbingwg/cni-log" | ||
| ) | ||
|
|
||
| const ( | ||
| labelCNIName = "cniName" | ||
| labelContainerID = "containerID" | ||
| labelNetNS = "netns" | ||
| labelIFName = "ifname" | ||
| cniName = "sriov-cni" | ||
| ) | ||
|
|
||
| var ( | ||
| logLevelDefault = cnilog.InfoLevel | ||
| containerID = "" | ||
| netNS = "" | ||
| ifName = "" | ||
| ) | ||
|
|
||
| // Init initializes logging with the requested parameters in this order: log level, log file, container ID, | ||
| // network namespace and interface name. | ||
| func Init(logLevel, logFile, containerIdentification, networkNamespace, interfaceName string) { | ||
| setLogLevel(logLevel) | ||
| setLogFile(logFile) | ||
| containerID = containerIdentification | ||
| netNS = networkNamespace | ||
| ifName = interfaceName | ||
| } | ||
|
|
||
| // setLogLevel sets the log level to either verbose, debug, info, warn, error or panic. If an invalid string is | ||
| // provided, it uses error. | ||
| func setLogLevel(l string) { | ||
| ll := cnilog.StringToLevel(l) | ||
| if ll == cnilog.InvalidLevel { | ||
| ll = logLevelDefault | ||
| } | ||
| cnilog.SetLogLevel(ll) | ||
| } | ||
|
|
||
| // setLogFile sets the log file for logging. If the empty string is provided, it uses stderr. | ||
| func setLogFile(fileName string) { | ||
| if fileName == "" { | ||
| cnilog.SetLogStderr(true) | ||
| cnilog.SetLogFile("") | ||
| return | ||
| } | ||
| cnilog.SetLogFile(fileName) | ||
| cnilog.SetLogStderr(false) | ||
|
There was a problem hiding this comment. so, is it exclusive? only file or only stderr, but not both? There was a problem hiding this comment. yeah that was my idea to have an "either log to file or log to stderr". The other model would be: "log to stderr and optionally log to file as well" .. or yet another option would be to expose the stderr switch to users as well and have 3 options. But I find the either/or one most intuitive. That said, I'm open to changing it if you strongly favor something else There was a problem hiding this comment. No, it's fine like it is. Just wanted to check if it was really intended. |
||
| } | ||
|
|
||
| // Debug provides structured logging for log level >= debug. | ||
| func Debug(msg string, args ...interface{}) { | ||
| cnilog.DebugStructured(msg, prependArgs(args)...) | ||
| } | ||
|
|
||
| // Info provides structured logging for log level >= info. | ||
| func Info(msg string, args ...interface{}) { | ||
| cnilog.InfoStructured(msg, prependArgs(args)...) | ||
| } | ||
|
|
||
| // Warning provides structured logging for log level >= warning. | ||
| func Warning(msg string, args ...interface{}) { | ||
| cnilog.WarningStructured(msg, prependArgs(args)...) | ||
| } | ||
|
|
||
| // Error provides structured logging for log level >= error. | ||
| func Error(msg string, args ...interface{}) { | ||
| _ = cnilog.ErrorStructured(msg, prependArgs(args)...) | ||
| } | ||
|
|
||
| // Panic provides structured logging for log level >= panic. | ||
| func Panic(msg string, args ...interface{}) { | ||
| cnilog.PanicStructured(msg, prependArgs(args)...) | ||
| } | ||
|
|
||
| // prependArgs prepends cniName, containerID, netNS and ifName to the args of every log message. | ||
| func prependArgs(args []interface{}) []interface{} { | ||
| if ifName != "" { | ||
| args = append([]interface{}{labelIFName, ifName}, args...) | ||
| } | ||
| if netNS != "" { | ||
| args = append([]interface{}{labelNetNS, netNS}, args...) | ||
| } | ||
| if containerID != "" { | ||
| args = append([]interface{}{labelContainerID, containerID}, args...) | ||
| } | ||
| args = append([]interface{}{labelCNIName, cniName}, args...) | ||
| return args | ||
| } | ||
This file contains 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,19 @@ | ||
| package logging | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| g "github.com/onsi/ginkgo/v2" | ||
| o "github.com/onsi/gomega" | ||
| ) | ||
|
|
||
| func TestConfig(t *testing.T) { | ||
| o.RegisterFailHandler(g.Fail) | ||
| g.RunSpecs(t, "Logging Suite") | ||
| } | ||
|
|
||
| var _ = g.BeforeSuite(func() { | ||
| }) | ||
|
|
||
| var _ = g.AfterSuite(func() { | ||
| }) |
Oops, something went wrong.
Oops, something went wrong.
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.
no needed if you remove it from init and set in main.go only if it is not empty.
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.
if you set the default level in init, then you can do:
if ll:= cnilog.StringToLevel(l), ll != cnilog.InvalidLevel {
cnilog.SetLogLevel(ll)
}