diff options
| author | Pravar Agrawal <pravaag1@in.ibm.com> | 2021-10-07 23:04:22 +0530 |
|---|---|---|
| committer | Pravar Agrawal <pravaag1@in.ibm.com> | 2021-10-10 22:43:20 +0530 |
| commit | ec0dcfbcc20002cbee0da861263660626202d031 (patch) | |
| tree | 3f89f7d9ab8268103e6202933d22ffc3ffa6f2ba /contributors | |
| parent | ab8c04d2791fefd899630a511ac59b76644dce81 (diff) | |
update documentation for verify-structured-logging
Diffstat (limited to 'contributors')
| -rw-r--r-- | contributors/devel/sig-testing/verify-tests.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/contributors/devel/sig-testing/verify-tests.md b/contributors/devel/sig-testing/verify-tests.md index 96c34cce..acec8c83 100644 --- a/contributors/devel/sig-testing/verify-tests.md +++ b/contributors/devel/sig-testing/verify-tests.md @@ -163,3 +163,21 @@ k8s.io/metrics Once it completes checking for code updates, later the script calls `update-codegen.sh` scripts. + + +## `verify-structured-logging` + +This script verifies if a package is properly migrated to structured +logging or not. The script involves verification steps based on new +klog methods which have few disallowed keywords like, + +```bash +* klog.Infof, klog.Info, klog.Infoln +* klog.InfoDepth +* klog.WarningDepth +* klog.Error, klog.Errorf, klog.Errorln +* klog.ErrorDepth +``` + +More info is available +[here](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/migration-to-structured-logging.md#change-log-functions-to-structured-equivalent). |