Skip to content

docs: add missing logging flags and remove capnslog#1106

Open
Mvrk08 wants to merge 1 commit intoetcd-io:mainfrom
Mvrk08:docs-add-logging-flags
Open

docs: add missing logging flags and remove capnslog#1106
Mvrk08 wants to merge 1 commit intoetcd-io:mainfrom
Mvrk08:docs-add-logging-flags

Conversation

@Mvrk08
Copy link

@Mvrk08 Mvrk08 commented Jan 20, 2026

Description :

This PR adds a new section for Logging flags to the configuration documentation. It documents the flags used for configuring the logger (zap), log levels, and rotation settings.

Changes included:

  • Added missing logging flags: --logger, --log-outputs, --log-level, --enable-log-rotation, and --log-rotation-config-json.

  • Build Fix: Updated the section header to ### Logging flags {#logging}. This adds an explicit anchor to fix the check-links failure in the Netlify build (the Quickstart guide links to #logging, which was previously missing).

Related Issue :
Fixes part of #1074

@k8s-ci-robot
Copy link

Hi @Mvrk08. Thanks for your PR.

I'm waiting for a etcd-io 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.

Details

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-sigs/prow repository.

@Mvrk08
Copy link
Author

Mvrk08 commented Jan 20, 2026

Just to bring the attention @ronaldngounou i raised a new pr for the same open for the review based on your last remarks in #1104

@ronaldngounou
Copy link
Member

Curious why you raised a new PR? Ok I will review.

@Mvrk08
Copy link
Author

Mvrk08 commented Jan 20, 2026

I encountered some issues fixing the commit history/DCO sign-off on my previous attempt, so I opted to open a fresh PR to ensure the history was clean.

@jberkus jberkus requested a review from ronaldngounou January 21, 2026 00:46
@jberkus
Copy link
Contributor

jberkus commented Jan 21, 2026

/ok-to-test

@ronaldngounou
Copy link
Member

ronaldngounou commented Jan 21, 2026

Before I start reviewing, could you please address the pull-website-lint failure here? @Mvrk08
https://prow.k8s.io/view/gs/kubernetes-ci-logs/pr-logs/pull/etcd-io_website/1106/pull-website-lint/2013775133998583808

@ronaldngounou
Copy link
Member

ronaldngounou commented Jan 21, 2026

I see you are working on the issue. Don't forget to rebase and squash your commits commits into 1 commit once you are done addressing the lint issues.
Once all is green, I will review.

@Mvrk08 Mvrk08 closed this Jan 21, 2026
@Mvrk08 Mvrk08 force-pushed the docs-add-logging-flags branch from 0f1f4ab to 5d1816a Compare January 21, 2026 20:09
@Mvrk08 Mvrk08 reopened this Jan 21, 2026
@k8s-ci-robot
Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Mvrk08
Once this PR has been reviewed and has the lgtm label, please assign wenjiaswe for approval. For more information see the Code Review Process.

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

Details 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

1 similar comment
@k8s-ci-robot
Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Mvrk08
Once this PR has been reviewed and has the lgtm label, please assign wenjiaswe for approval. For more information see the Code Review Process.

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

Details 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

@Mvrk08 Mvrk08 force-pushed the docs-add-logging-flags branch 4 times, most recently from ceb835d to b07f3c8 Compare January 21, 2026 21:05
@Mvrk08
Copy link
Author

Mvrk08 commented Jan 21, 2026

I see you are working on the issue. Don't forget to rebase and squash your commits commits into 1 commit once you are done addressing the lint issues. Once all is green, I will review.

Updated all the things @ronaldngounou as you asked let me know if anything else .

@ronaldngounou
Copy link
Member

The changes in the PR don't achieve the intent of this issue. The changes are unrelated to adding missing logging flags.

@Mvrk08 Mvrk08 force-pushed the docs-add-logging-flags branch 2 times, most recently from b7415bd to e952bb6 Compare January 22, 2026 07:30
@Mvrk08 Mvrk08 force-pushed the docs-add-logging-flags branch from e952bb6 to 527dc7f Compare January 22, 2026 07:36
@Mvrk08 Mvrk08 force-pushed the docs-add-logging-flags branch from 527dc7f to 3f157ad Compare January 22, 2026 08:00
Signed-off-by: mrmahi2003 <maahirchauhan20@icloud.com>
@Mvrk08 Mvrk08 force-pushed the docs-add-logging-flags branch from 3f157ad to 60c517e Compare January 22, 2026 08:13
Copy link
Contributor

@jberkus jberkus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey, some questions about changes in this PR that I don't quite understand.

'gone' // v2store is not maintained any longer. (planned default in v3.7)
```

### Logging flags {#logging}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason for moving the Logging section?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's not necessarily a blocker, but I don't understand the logic of the section move.


{{% alert color="warning" %}}
<i class="fas fa-exclamation-triangle mr-1"></i> **Caution**: If you mix-and-match configuration options, then the following
<**Caution**: If you mix-and-match configuration options, then the following
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not clear on why you're removing the alert triangles as part of this update. How is that related to fixing the flags?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants