Skip to content

Commit ec0dcfb

Browse files
committed
update documentation for verify-structured-logging
1 parent ab8c04d commit ec0dcfb

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

contributors/devel/sig-testing/verify-tests.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,3 +163,21 @@ k8s.io/metrics
163163

164164
Once it completes checking for code updates, later the script calls
165165
`update-codegen.sh` scripts.
166+
167+
168+
## `verify-structured-logging`
169+
170+
This script verifies if a package is properly migrated to structured
171+
logging or not. The script involves verification steps based on new
172+
klog methods which have few disallowed keywords like,
173+
174+
```bash
175+
* klog.Infof, klog.Info, klog.Infoln
176+
* klog.InfoDepth
177+
* klog.WarningDepth
178+
* klog.Error, klog.Errorf, klog.Errorln
179+
* klog.ErrorDepth
180+
```
181+
182+
More info is available
183+
[here](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/migration-to-structured-logging.md#change-log-functions-to-structured-equivalent).

0 commit comments

Comments
 (0)