Skip to content

docs: add missing logging flags and remove capnslog #1106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Mvrk08 wants to merge 1 commit into
base: main
Choose a base branch
from
+26 −18
Open

docs: add missing logging flags and remove capnslog #1106

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 26 additions & 18 deletions content/en/docs/v3.5/op-guide/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ You can configure etcd through the following:
- **[Configuration file](#configuration-file)**

{{% 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
Copy Markdown
Contributor

@jberkus jberkus Jan 29, 2026

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?

rules apply.

- Command-line flags take precedence over environment variables.
Expand All @@ -30,7 +30,7 @@ The list of flags provided below may not be up-to-date due to ongoing developmen
**Note**: For details concerning new, updated, and deprecated {{< param version >}} flags,
see [CHANGELOG-{{< psubstr version 1 >}}.md][changelog].

[changelog]: https://github.com/etcd-io/etcd/blob/main/CHANGELOG/CHANGELOG-{{< psubstr version 1 >}}.md
[changelog]: <https://github.com/etcd-io/etcd/blob/main/CHANGELOG/CHANGELOG>-{{< psubstr version 1 >}}.md
{{% /alert %}}

### Member
Expand Down Expand Up @@ -83,6 +83,7 @@ The list of flags provided below may not be up-to-date due to ongoing developmen
--socket-reuse-address 'false'
Enable to set socket option SO_REUSEADDR on listeners allowing binding to an address in TIME_WAIT state.
```

### Clustering

```nocode
Expand Down Expand Up @@ -127,6 +128,22 @@ The list of flags provided below may not be up-to-date due to ongoing developmen
'write-only-drop-data' // Custom v2 state will get DELETED !
'gone' // v2store is not maintained any longer. (planned default in v3.7)
```

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

@jberkus jberkus Jan 29, 2026

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
Copy Markdown
Contributor

@jberkus jberkus Jan 29, 2026

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.


```nocode
--logger 'zap'
Currently only supports 'zap' for structured logging.
--log-outputs 'default'
Specify 'stdout' or 'stderr' to skip journald logging even when running under systemd, or list of comma separated output targets.
--log-level 'info'
Configures log level. Only supports debug, info, warn, error, panic, or fatal.
--enable-log-rotation 'false'
Enable log rotation of a single log-outputs file target.
--log-rotation-config-json '{"maxsize": 100, "maxage": 0, "maxbackups": 0, "localtime": false, "compress": false}'
Configures log rotation if enabled with a JSON logger config. MaxSize(MB), MaxAge(days,0=no limit), MaxBackups(0=no limit), LocalTime(use computers local time), Compress(gzip)".
```

### Security

```nocode
Expand Down Expand Up @@ -176,6 +193,7 @@ The list of flags provided below may not be up-to-date due to ongoing developmen
--tls-max-version ''
Maximum TLS version supported by etcd (empty will be auto-populated by Go).
```

### Auth

```nocode
Expand All @@ -186,6 +204,7 @@ The list of flags provided below may not be up-to-date due to ongoing developmen
--auth-token-ttl 300
Time (in seconds) of the auth-token-ttl.
```

### Profiling and monitoring

```nocode
Expand All @@ -196,20 +215,7 @@ The list of flags provided below may not be up-to-date due to ongoing developmen
--listen-metrics-urls ''
List of URLs to listen on for the metrics and health endpoints.
```
### Logging

```nocode
--logger 'zap'
Currently only supports 'zap' for structured logging.
--log-outputs 'default'
Specify 'stdout' or 'stderr' to skip journald logging even when running under systemd, or list of comma separated output targets.
--log-level 'info'
Configures log level. Only supports debug, info, warn, error, panic, or fatal.
--enable-log-rotation 'false'
Enable log rotation of a single log-outputs file target.
--log-rotation-config-json '{"maxsize": 100, "maxage": 0, "maxbackups": 0, "localtime": false, "compress": false}'
Configures log rotation if enabled with a JSON logger config. MaxSize(MB), MaxAge(days,0=no limit), MaxBackups(0=no limit), LocalTime(use computers local time), Compress(gzip)".
```
### Experimental distributed tracing

```nocode
Expand All @@ -224,13 +230,13 @@ The list of flags provided below may not be up-to-date due to ongoing developmen
--experimental-distributed-tracing-sampling-rate '0'
Number of samples to collect per million spans for OpenTelemetry Tracing (if enabled with experimental-enable-distributed-tracing flag).
```

### v2 Proxy

{{% alert color="warning" %}}
**<i class="fas fa-exclamation-triangle mr-1"></i> Note**: flags will be deprecated in v3.6.
**Note**: flags will be deprecated in v3.6.
{{% /alert %}}


```nocode
--proxy 'off'
Proxy mode setting ('off', 'readonly' or 'on').
Expand All @@ -245,6 +251,7 @@ The list of flags provided below may not be up-to-date due to ongoing developmen
--proxy-read-timeout 0
Time (in milliseconds) for a read to timeout.
```

### Experimental features

```nocode
Expand All @@ -269,10 +276,11 @@ The list of flags provided below may not be up-to-date due to ongoing developmen
--experimental-bootstrap-defrag-threshold-megabytes
Enable the defrag during etcd server bootstrap on condition that it will free at least the provided threshold of disk space. Needs to be set to non-zero value to take effect.
```

### Unsafe features

{{% alert color="warning" %}}
**<i class="fas fa-exclamation-triangle mr-1"></i> Warning**: using unsafe features may break the guarantees given by the consensus protocol!
**Warning**: using unsafe features may break the guarantees given by the consensus protocol!
{{% /alert %}}

```nocode
Expand Down