search

kubernetes-csi / node-driver-registrar

Sidecar container that registers a CSI driver with the kubelet using the kubelet plugin registration mechanism.
Apache License 2.0
123 stars 133 forks source link

Support structured logging #337

Closed rlia closed 8 months ago

rlia commented 9 months ago

What type of PR is this?

/kind feature

What this PR does / why we need it:

In this PR I have added JSON logging. With this change, it is now possible to output the logs of the node-driver-register in JSON format. Running the container with the --logging-format=json option will output the logs in JSON format.

In addition, I've modified the log messages based on the following guideline: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/migration-to-structured-logging.md#remove-string-formatting-from-log-message

I’ve update the klog functions in use according to the guidelines provided below, and I've confirmed that they pass the logcheck tests: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/migration-to-structured-logging.md#change-log-functions

$ logcheck ./cmd/csi-node-driver-registrar/

Which issue(s) this PR fixes:

Fixes #228

Special notes for your reviewer:

$ ./bin/csi-node-driver-registrar --logging-format json
{"ts":1695281742857.0557,"caller":"csi-node-driver-registrar/main.go:196","msg":"kubelet-registration-path is a required parameter"}
$ ./bin/csi-node-driver-registrar --logging-format text
E0921 16:35:45.474034   13268 main.go:196] "kubelet-registration-path is a required parameter"
$ ./bin/csi-node-driver-registrar 
E0921 16:35:50.030637   13337 main.go:196] "kubelet-registration-path is a required parameter"
$ ./bin/csi-node-driver-registrar --logging-format unknown
E0921 16:39:12.117575   14012 main.go:190] "" err="format: Invalid value: \"unknown\": Unsupported log format"

Does this PR introduce a user-facing change?:

Added support for structured logging (the log messages have been changed due to the activation of structured logging)
linux-foundation-easycla[bot] commented 9 months ago

CLA Signed

The committers listed above are authorized under a signed CLA.

k8s-ci-robot commented 9 months ago

Welcome @rlia!

It looks like this is your first PR to kubernetes-csi/node-driver-registrar 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-csi/node-driver-registrar has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. :smiley:

k8s-ci-robot commented 9 months ago

Hi @rlia. Thanks for your PR.

I'm waiting for a kubernetes-csi member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
bells17 commented 8 months ago

/ok-to-test

jsafrane commented 8 months ago

@rlia can you please rebase + check why the unit tests failed for your PR?

k8s-ci-robot commented 8 months ago

PR needs rebase.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
k8s-ci-robot commented 8 months ago

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: rlia

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files: Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment