Skip to content

Commit 18490b7

Browse files
docs: document error logging enabled by default
Error logging now writes to /var/log/zentinel/error.log at warn level without explicit configuration. Updated observability guide, getting started page, and directives reference to reflect the new default.
1 parent 4a3d20e commit 18490b7

3 files changed

Lines changed: 20 additions & 4 deletions

File tree

content/configuration/observability.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
+++
22
title = "Observability"
33
weight = 8
4-
updated = 2026-02-19
4+
updated = 2026-02-25
55
+++
66

77
Zentinel provides comprehensive observability through metrics, logging, and distributed tracing. All observability features are configured in the `observability` block.
@@ -136,7 +136,9 @@ observability {
136136

137137
### Error Log
138138

139-
Error and warning logging:
139+
Error and warning logging. **Error logging is enabled by default** — even without explicit configuration, Zentinel writes errors and warnings to `/var/log/zentinel/error.log`. The directory is created automatically if it doesn't exist.
140+
141+
To customize:
140142

141143
```kdl
142144
observability {
@@ -151,13 +153,25 @@ observability {
151153
}
152154
```
153155

156+
To disable error file logging:
157+
158+
```kdl
159+
observability {
160+
logging {
161+
error-log {
162+
enabled #false
163+
}
164+
}
165+
}
166+
```
167+
154168
#### Error Log Options
155169

156170
| Option | Default | Description |
157171
|--------|---------|-------------|
158172
| `enabled` | `true` | Enable error logging |
159173
| `file` | `/var/log/zentinel/error.log` | Log file path |
160-
| `level` | `warn` | Minimum level to log |
174+
| `level` | `warn` | Minimum level to log (`warn` or `error`) |
161175
| `buffer-size` | `8192` | Write buffer size |
162176

163177
### Audit Log

content/getting-started/basic-configuration.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -260,6 +260,8 @@ observability {
260260
}
261261
```
262262

263+
> **Note:** Error logging to `/var/log/zentinel/error.log` is enabled by default at `warn` level — no explicit configuration required. See [Observability](/configuration/observability/) for customization options.
264+
263265
## Complete Example
264266

265267
Here's a production-ready configuration:

content/reference/directives.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3694,7 +3694,7 @@ logging {
36943694

36953695
### `error-log`
36963696

3697-
Error log configuration.
3697+
Error log configuration. **Enabled by default** — writes to `/var/log/zentinel/error.log` at `warn` level without explicit configuration.
36983698

36993699
**Context:** `logging`
37003700

0 commit comments

Comments
 (0)