Skip to content

Added ADR-005: Define log levels#2948

Merged
predic8 merged 2 commits into
masterfrom
adr-log-levels
May 22, 2026
Merged

Added ADR-005: Define log levels#2948
predic8 merged 2 commits into
masterfrom
adr-log-levels

Conversation

@predic8
Copy link
Copy Markdown
Member

@predic8 predic8 commented May 18, 2026

Summary by CodeRabbit

  • Documentation
    • Added comprehensive logging level definitions and guidelines for the system.
    • Updated logging documentation to clarify that the system ships with INFO log level for development environments.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 18, 2026

📝 Walkthrough

Walkthrough

This PR adds ADR-005 Log Levels, defining six logging levels (FATAL, ERROR, WARN, INFO, DEBUG, TRACE) with meanings and example use-cases. It also includes an explicit directive not to log 404 Not Found responses. ADR-004 Logging is updated to document that the system ships with INFO log level in development.

Changes

Logging Standards

Layer / File(s) Summary
Logging levels and development defaults
docs/ADRs.md
New ADR-005 documents six logging levels (FATAL, ERROR, WARN, INFO, DEBUG, TRACE) with meanings and example scenarios, plus a "do not log" rule for 404 responses. ADR-004 is updated to specify INFO as the default development log level.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Six levels of logs, from FATAL to TRACE,
A rabbit records every place,
But 404s hop away silent and free,
INFO by default's the key,
Decisions recorded for all eyes to see! 🐾

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically describes the main change: adding a new architecture decision record (ADR-005) that defines logging levels.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch adr-log-levels

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/ADRs.md`:
- Around line 55-56: The ADR currently bans logging 404s via the line "Do not
Log: - 404 Not Found"; update that rule to be scoped guidance instead: replace
the absolute prohibition with text that says 404s should not be logged at ERROR
level when they are expected, but may be recorded at INFO/DEBUG level, via
sampling/aggregation, or elevated for security-sensitive endpoints; reference
the existing phrase "Do not Log: - 404 Not Found" and modify it to clarify
acceptable logging levels, sampling, and exceptions for security or routing
regressions.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 75df8eba-3743-418f-8147-02a2c4a87d40

📥 Commits

Reviewing files that changed from the base of the PR and between 003b0e9 and 5c9d449.

📒 Files selected for processing (1)
  • docs/ADRs.md

Comment thread docs/ADRs.md
@predic8 predic8 marked this pull request as ready for review May 18, 2026 18:37
@membrane-ci-server
Copy link
Copy Markdown

This pull request needs "/ok-to-test" from an authorized committer.

@predic8 predic8 merged commit 6662056 into master May 22, 2026
4 of 5 checks passed
@predic8 predic8 deleted the adr-log-levels branch May 22, 2026 07:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants