Skip to content

Commit 6462a83

Browse files
authored
Merge pull request #3016 from christopherhein/chore/switch-devel-to-klog
Change devel guide glog references to klog
2 parents 672fc84 + 744d649 commit 6462a83

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

contributors/devel/logging.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
11
## Logging Conventions
22

3-
The following conventions for the glog levels to use.
4-
[glog](http://godoc.org/github.com/golang/glog) is globally preferred to
3+
The following conventions for the klog levels to use.
4+
[klog](http://godoc.org/github.com/kubernetes/klog) is globally preferred to
55
[log](http://golang.org/pkg/log/) for better runtime control.
66

7-
* glog.Errorf() - Always an error
7+
* klog.Errorf() - Always an error
88

9-
* glog.Warningf() - Something unexpected, but probably not an error
9+
* klog.Warningf() - Something unexpected, but probably not an error
1010

11-
* glog.Infof() has multiple levels:
12-
* glog.V(0) - Generally useful for this to ALWAYS be visible to an operator
11+
* klog.Infof() has multiple levels:
12+
* klog.V(0) - Generally useful for this to ALWAYS be visible to an operator
1313
* Programmer errors
1414
* Logging extra info about a panic
1515
* CLI argument handling
16-
* glog.V(1) - A reasonable default log level if you don't want verbosity.
16+
* klog.V(1) - A reasonable default log level if you don't want verbosity.
1717
* Information about config (listening on X, watching Y)
1818
* Errors that repeat frequently that relate to conditions that can be corrected (pod detected as unhealthy)
19-
* glog.V(2) - Useful steady state information about the service and important log messages that may correlate to significant changes in the system. This is the recommended default log level for most systems.
19+
* klog.V(2) - Useful steady state information about the service and important log messages that may correlate to significant changes in the system. This is the recommended default log level for most systems.
2020
* Logging HTTP requests and their exit code
2121
* System state changing (killing pod)
2222
* Controller state change events (starting pods)
2323
* Scheduler log messages
24-
* glog.V(3) - Extended information about changes
24+
* klog.V(3) - Extended information about changes
2525
* More info about system state changes
26-
* glog.V(4) - Debug level verbosity
26+
* klog.V(4) - Debug level verbosity
2727
* Logging in particularly thorny parts of code where you may want to come back later and check it
28-
* glog.V(5) - Trace level verbosity
28+
* klog.V(5) - Trace level verbosity
2929
* Context to understand the steps leading up to errors and warnings
3030
* More information for troubleshooting reported issues
3131

0 commit comments

Comments
 (0)