Repository navigation
Docs: document the log format and correct the level descriptions - #27
Merged
Merged
Conversation
The support doc said both Nginx and the API log to stdout. Nginx now sends request errors to stderr and keeps no access log, so the claim is restated. Adds the record shape, the five level abbreviations, the fact that audit records are never filtered, and one line for anyone shipping to Loki, since the format is logfmt and needs no custom parser. warn and error share a threshold and behave identically. The Compose comment and the environment table both listed four levels as though they were four behaviours.
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
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
docs/support.mdthat both Nginx and the API log to stdout. Nginx sends request errors to stderr and keeps no access log.AUDis never filtered by the level setting, that the banner is unstructured and always prints, and that secrets are never logged.| logfmtparses it in Loki or Grafana with no custom rules.LOG_LEVELrow indocs/architecture.mdrather than restating the boot-versus-settings precedence it already covers.docs/architecture.mdanddocker-compose.ymlthatwarnanderrorbehave the same; they share a threshold, and listing four names implied four behaviours.Unreleasedentries for this work, under Added, Changed, Fixed and Security.Merged last of the five, so it describes what actually shipped. The level names the environment-table row check depends on are unchanged.
Testing
All green, including the Docker build. Documentation only; no new tests, and the existing environment-doc row checks still pass.
Checklist