kubernetes
/
community
mirror of https://github.com/kubernetes/community.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #3016 from christopherhein/chore/switch-devel-to-klog 

Change devel guide glog references to klog
This commit is contained in:
Kubernetes Prow Robot 2018-12-06 10:01:18 -08:00 committed by GitHub
parent 672fc8472b 744d649e9a
commit 6462a8306f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
contributors/devel/logging.md
View File

@ -1,31 +1,31 @@
## Logging Conventions
The following conventions for the glog levels to use.
[glog](http://godoc.org/github.com/golang/glog) is globally preferred to
The following conventions for the klog levels to use.
[klog](http://godoc.org/github.com/kubernetes/klog) is globally preferred to
[log](http://golang.org/pkg/log/) for better runtime control.
* glog.Errorf() - Always an error
* klog.Errorf() - Always an error
* glog.Warningf() - Something unexpected, but probably not an error
* klog.Warningf() - Something unexpected, but probably not an error
* glog.Infof() has multiple levels:
* glog.V(0) - Generally useful for this to ALWAYS be visible to an operator
* klog.Infof() has multiple levels:
* klog.V(0) - Generally useful for this to ALWAYS be visible to an operator
* Programmer errors
* Logging extra info about a panic
* CLI argument handling
* glog.V(1) - A reasonable default log level if you don't want verbosity.
* klog.V(1) - A reasonable default log level if you don't want verbosity.
* Information about config (listening on X, watching Y)
* Errors that repeat frequently that relate to conditions that can be corrected (pod detected as unhealthy)
* 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.
* 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.
* Logging HTTP requests and their exit code
* System state changing (killing pod)
* Controller state change events (starting pods)
* Scheduler log messages
* glog.V(3) - Extended information about changes
* klog.V(3) - Extended information about changes
* More info about system state changes
* glog.V(4) - Debug level verbosity
* klog.V(4) - Debug level verbosity
* Logging in particularly thorny parts of code where you may want to come back later and check it
* glog.V(5) - Trace level verbosity
* klog.V(5) - Trace level verbosity
* Context to understand the steps leading up to errors and warnings
* More information for troubleshooting reported issues