From ec0dcfbcc20002cbee0da861263660626202d031 Mon Sep 17 00:00:00 2001 From: Pravar Agrawal Date: Thu, 7 Oct 2021 23:04:22 +0530 Subject: update documentation for verify-structured-logging --- contributors/devel/sig-testing/verify-tests.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) 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). -- cgit v1.2.3