k8s.io/kubernetes@v1.31.0-alpha.0.0.20240520171757-56147500dadc/hack/logcheck.conf (about)

     1  # hack/logcheck.conf contains regular expressions that are matched against <pkg>/<file>,
     2  # for example k8s.io/cmd/kube-scheduler/app/config/config.go.
     3  #
     4  # By default, structured logging call parameters are checked, but usage of
     5  # those calls is not required. That is changed on a per-file basis.
     6  #
     7  # Remember to clean the golangci-lint cache when changing the configuration and
     8  # running the verify-golangci-lint.sh script multiple times, otherwise
     9  # golangci-lint will report stale results:
    10  #    _output/local/bin/golangci-lint cache clean
    11  
    12  # At this point we don't enforce the usage structured logging calls except in
    13  # those packages that were migrated. This disables the check for other files.
    14  -structured .*
    15  
    16  # Now enable it again for migrated packages.
    17  structured k8s.io/kubernetes/cmd/kubelet/.*
    18  structured k8s.io/kubernetes/pkg/kubelet/.*
    19  structured k8s.io/kubernetes/pkg/proxy/.*
    20  structured k8s.io/kms/.*
    21  structured k8s.io/apiserver/pkg/storage/value/.*
    22  structured k8s.io/apiserver/pkg/server/options/encryptionconfig/.*
    23  
    24  # The following packages have been migrated to contextual logging.
    25  # Packages matched here do not have to be listed above because
    26  # "contextual" implies "structured".
    27  contextual k8s.io/api/.*
    28  contextual k8s.io/apimachinery/pkg/util/runtime/.*
    29  contextual k8s.io/client-go/metadata/.*
    30  contextual k8s.io/client-go/tools/events/.*
    31  contextual k8s.io/client-go/tools/record/.*
    32  contextual k8s.io/component-helpers/.*
    33  contextual k8s.io/cri-api/.*
    34  contextual k8s.io/cri-client/.*
    35  contextual k8s.io/dynamic-resource-allocation/.*
    36  contextual k8s.io/endpointslice/.*
    37  contextual k8s.io/kms/.*
    38  contextual k8s.io/kube-controller-manager/.*
    39  contextual k8s.io/kube-proxy/.*
    40  contextual k8s.io/kube-scheduler/.*
    41  contextual k8s.io/sample-apiserver/.*
    42  contextual k8s.io/sample-cli-plugin/.*
    43  contextual k8s.io/sample-controller/.*
    44  contextual k8s.io/kubernetes/cmd/kube-proxy/.*
    45  contextual k8s.io/kubernetes/cmd/kube-scheduler/.*
    46  contextual k8s.io/kubernetes/pkg/controller/.*
    47  contextual k8s.io/kubernetes/pkg/scheduler/.*
    48  contextual k8s.io/kubernetes/test/e2e/dra/.*
    49  
    50  # As long as contextual logging is alpha or beta, all WithName, WithValues,
    51  # NewContext calls have to go through klog. Once it is GA, we can lift
    52  # this restriction. Whether we then do a global search/replace remains
    53  # to be decided.
    54  with-helpers .*