docs: clarify metrics endpoint and non-root logging#6
Merged
Conversation
Reflects the proxy fixes in zentinelproxy/zentinel#255 and #256: - Observability: note that the metrics endpoint is a dedicated listener (separate from route listeners, bindable to an internal address) and logs a startup line; document that file logging is skipped with a warning when the process can't write /var/log/zentinel (non-root / container), with stdout and writable-volume guidance. - Docker: explain that the image runs non-root and logs to stdout by default, so docker logs works without a volume; /var/log/zentinel is only needed (and must be writable) when file logging is enabled. Refs zentinelproxy/zentinel#254
Deploying zentinelproxy-io-docs with
|
| Latest commit: |
ca61457
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://577ce9a9.zentinelproxy-io-docs.pages.dev |
| Branch Preview URL: | https://docs-metrics-and-logging-not.zentinelproxy-io-docs.pages.dev |
2 tasks
raffaelschneider
added a commit
that referenced
this pull request
Jun 7, 2026
- Snapshot the current top-level docs into `content/v/26.06/` so the version picker can serve a frozen 26.06 archive. - Update `config.toml` version picker: `current = "26.06"`, add a 26.06 (latest) entry, and demote 26.05 to `/v/26.05/` archive. 26.06 inherits the 26.06_1 docs that already landed: metrics endpoint as a dedicated listener with non-root logging caveats (#6), upstream `target` syntax normalization (#5), and the route-level circuit-breaker / retry-policy not-yet-implemented banner (#7). Refs zentinelproxy/zentinel#254 #255 #256 #258, release 26.06_1 (0.6.15).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Follows up the code fixes in zentinelproxy/zentinel#255 and #256 (and the umbrella report #254) by aligning the user-facing docs with the new behavior.
configuration/observability.md):metrics.address, separate from route listeners — note that it can be bound to an internal interface to keep it private, and that the proxy logsMetrics server listening …(or a loud failure) at startup./var/log/zentinelisn't writable, file logging is skipped with a warning and the proxy continues (errors still go to stdout). Guidance to log to stdout in containers or mount a writable volume.deployment/docker.md): the image runs non-root and the bundled config logs to stdout/stderr, sodocker logsworks without a volume;/var/log/zentinelis only needed (and must be writable) when file logging is explicitly enabled — which is why the reporter'stmpfsattempt failed.Test plan
Refs zentinelproxy/zentinel#254, zentinelproxy/zentinel#255, zentinelproxy/zentinel#256