add support to configure logging format

[aramase]

What type of PR is this?

Uncomment only one /kind <> line, hit enter to put that in a new line, and remove leading whitespaces from that line:

/kind feature

What this PR does / why we need it:
Adds configuration for json log formatter

Which issue(s) this PR fixes:

Fixes #97

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

added --log-format-json=<true | false> set log formatter to json (default: false)

[k8s-ci-robot]

Welcome @aramase!

It looks like this is your first PR to kubernetes-csi/livenessprobe 🎉. 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/livenessprobe 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. 😃

[k8s-ci-robot]

Hi @aramase. 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. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[aramase]

/kind feature

[aramase]

/assign @msau42

[Jiawei0227]

Can you help to rebase this?

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: aramase
To complete the pull request process, please assign msau42 after the PR has been reviewed.
You can assign the PR to them by writing /assign @msau42 in a comment when ready.

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

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[aramase]

Can you help to rebase this?

Done!

[Jiawei0227]

/ok-to-test

[aramase]

@verult If we want to include this in the next release, I can dust off the PR again. There has been some conversation on how to approach this: kubernetes-csi/node-driver-registrar#129.

[msau42]

I believe @pohly was starting to look into structured logging for the csi sidecars.

[aramase]

I believe @pohly was starting to look into structured logging for the csi sidecars.

Ah, gotcha! @pohly Let me know how I can help. With structured logging, we should still be able to support json log format.

[verult]

@aramase @msau42 @pohly my understanding from kubernetes-csi/node-driver-registrar#129 is that even with structured logging, we still need to add json logging separately. Does json logging depend on the structured logging work? Do you think either structured logging or json logging would be able to land for this current sidecar release cycle?

[pohly]

We should start an issue about structured logging where discuss all related aspects (configuration, log calls, how to pass a logger). This isn't specific to a certain sidecar.

@msau42: would that be worth a separate project under https://github.com/orgs/kubernetes-csi/projects?

[msau42]

We should start an issue about structured logging where discuss all related aspects (configuration, log calls, how to pass a logger). This isn't specific to a certain sidecar.

Michelle Au: would that be worth a separate project under https://github.com/orgs/kubernetes-csi/projects?

Yeah that sounds good to me! Agree that we want to be consistent across sidecars and also consistent with the Kubernetes effort.

[verult]

Ack, since this requires a wider effort we'll leave it out of this release. Thanks all!

[pohly]

would that be worth a separate project under https://github.com/orgs/kubernetes-csi/projects?

I created https://github.com/orgs/kubernetes-csi/projects/46. Let's discuss in one of the upcoming CSI standup meetings.

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle stale
• Mark this issue or PR as rotten with /lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[pierluigilenoci]

@aramase could you please fix the PR?

[pohly]

/hold

Let's not merge this without aligning on a common direction for all sidecars first. See https://github.com/orgs/kubernetes-csi/projects/46 for a list of TODOs.

[k8s-triage-robot]

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

[pierluigilenoci]

/remove-lifecycle rotten

[pierluigilenoci]

This is still an issue

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle stale
• Mark this issue or PR as rotten with /lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[pierluigilenoci]

/remove-lifecycle stale

[pierluigilenoci]

@aramase could you please take a look?

[aramase]

@pierluigilenoci I will let the maintainers of the node-driver-registrar and liveness probe decide how they want to proceed with supporting json log formatting. I don't have the time currently for rebasing the 2 PRs, so I'm going to close them and let someone else pick up the issue if there is interest in supporting the json log format.

/close

[k8s-ci-robot]

@aramase: Closed this PR.

In response to this:

@pierluigilenoci I will let the maintainers of the node-driver-registrar and liveness probe decide how they want to proceed with supporting json log formatting. I don't have the time currently for rebasing the 2 PRs, so I'm going to close them and let someone else pick up the issue if there is interest in supporting the json log format.

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.