feat(middleware): skip /readyz by default and add WithExcludedRoutes#10
Merged
Conversation
WalkthroughAdds configurable, prefix-based excluded routes to HTTP logging (defaults: /health, /readyz, /metrics), enforces segment-boundary matching, integrates an exported WithExcludedRoutes option, uses the exclusion list for early-return in the middleware, and adds unit tests validating behavior. ChangesAccess-log route exclusion feature
Warning Review ran into problems🔥 ProblemsStopped waiting for pipeline failures after 30000ms. One of your pipelines takes longer than our 30000ms fetch window to run, so review may not consider pipeline-failure results for inline comments if any failures occurred after the fetch window. Increase the timeout if you want to wait longer or run a Comment |
lerian-studio
added
size/S
Contributor
🔒 Security Scan Results —
|
| Stage | Status | Blocking? |
|---|---|---|
| Filesystem Scan | ✅ Clean | — |
| Docker Image Scan | ➖ Skipped | — |
| Docker Hub Health Score | ➖ Skipped | — |
| Pre-release Version Check | ✅ Clean | — |
Trivy
Filesystem Scan
✅ No vulnerabilities or secrets found.
Pre-release Version Check
✅ No unstable version pins found.
Contributor
🔍 PR Validation Summary✅ PR Mergeable — no blocking failures
|
Contributor
📊 Unit Test Coverage Report:
|
| Metric | Value |
|---|---|
| Overall Coverage | 84.4% ✅ PASS |
| Threshold | 80% |
Coverage by Package
| Package | Coverage |
|---|---|
github.com/LerianStudio/lib-observability/assert |
97.9% |
github.com/LerianStudio/lib-observability/constants |
83.3% |
github.com/LerianStudio/lib-observability/log |
94.9% |
github.com/LerianStudio/lib-observability/metrics |
91.4% |
github.com/LerianStudio/lib-observability/middleware |
68.4% |
github.com/LerianStudio/lib-observability/redaction |
95.8% |
github.com/LerianStudio/lib-observability/runtime |
80.4% |
github.com/LerianStudio/lib-observability/tracing |
84.9% |
github.com/LerianStudio/lib-observability/zap |
96.0% |
github.com/LerianStudio/lib-observability |
91.1% |
Generated by Go PR Analysis workflow
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
lerian-studio
added
size/M
…ludedRoutes tests
brunognovaes
force-pushed
the
fix/remove-readyz-logging
branch
from
4eab6b2 to
5f3e048
Compare
There was a problem hiding this comment.
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 `@middleware/logging.go`:
- Around line 218-220: The early return when isRouteExcludedFromList(c,
mid.ExcludedRoutes) causes excluded routes to skip request-context setup
(setRequestHeaderID and logger context), so change the flow in the middleware to
always run setRequestHeaderID(c) and wire the request-scoped logger before
checking exclusion; then use isRouteExcludedFromList only to skip emitting
access logs (i.e., call c.Next() after context setup but avoid the access-log
path for excluded routes). Ensure WithExcludedRoutes still references
mid.ExcludedRoutes and the exclusion check happens after request ID/header and
logger are installed.
🪄 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: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: d4eb1489-08a5-4024-aa32-40e338f5071c
📒 Files selected for processing (4)
middleware/helpers.gomiddleware/helpers_test.gomiddleware/logging.gomiddleware/logging_test.go
There was a problem hiding this comment.
♻️ Duplicate comments (1)
middleware/logging.go (1)
218-220:⚠️ Potential issue | 🟠 Major | ⚡ Quick winExcluded-route early return skips request context setup.
At Line 218,
return c.Next()runs beforesetRequestHeaderIDand logger context wiring, soWithExcludedRoutes(...)suppresses more than access logs (excluded paths lose request ID/header + request-scoped logger).Proposed fix
func WithHTTPLogging(opts ...LogMiddlewareOption) fiber.Handler { return func(c *fiber.Ctx) error { mid := buildOpts(opts...) + setRequestHeaderID(c) + requestID := c.Get(headerID) + logger := mid.Logger. + With(obslog.String(headerID, requestID)). + With(obslog.String("message_prefix", requestID+constant.LoggerDefaultSeparator)) + c.SetUserContext(observability.ContextWithLogger(c.UserContext(), logger)) + if isRouteExcludedFromList(c, mid.ExcludedRoutes) { return c.Next() } if strings.Contains(c.Path(), "swagger") && c.Path() != "/swagger/index.html" { return c.Next() } - - setRequestHeaderID(c) info := NewRequestInfo(c, mid.ObfuscationDisabled) - - requestID := c.Get(headerID) - logger := mid.Logger. - With(obslog.String(headerID, info.TraceID)). - With(obslog.String("message_prefix", requestID+constant.LoggerDefaultSeparator)) - - ctx := observability.ContextWithLogger(c.UserContext(), logger) - c.SetUserContext(ctx)🤖 Prompt for 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. In `@middleware/logging.go` around lines 218 - 220, The early return when an excluded route is detected (call to isRouteExcludedFromList with mid.ExcludedRoutes) bypasses request setup — move the request-scoped setup (call(s) to setRequestHeaderID and the logger context wiring) so they always run before returning to c.Next(), or alternatively, perform setRequestHeaderID and attach the request-scoped logger even for excluded routes before executing the early return; update the logic in the middleware handling excluded routes to ensure setRequestHeaderID and the request logger are invoked for all requests while preserving suppression of access logs for excluded paths.
🤖 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.
Duplicate comments:
In `@middleware/logging.go`:
- Around line 218-220: The early return when an excluded route is detected (call
to isRouteExcludedFromList with mid.ExcludedRoutes) bypasses request setup —
move the request-scoped setup (call(s) to setRequestHeaderID and the logger
context wiring) so they always run before returning to c.Next(), or
alternatively, perform setRequestHeaderID and attach the request-scoped logger
even for excluded routes before executing the early return; update the logic in
the middleware handling excluded routes to ensure setRequestHeaderID and the
request logger are invoked for all requests while preserving suppression of
access logs for excluded paths.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: bebc4ed3-ecbd-451a-9711-2534b8112a1b
📒 Files selected for processing (4)
middleware/helpers.gomiddleware/helpers_test.gomiddleware/logging.gomiddleware/logging_test.go
qnen
approved these changes
May 19, 2026
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
3 participants
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.
Lib Observability
Description
Type of Change
feat: New feature or capabilityfix: Bug fixperf: Performance improvementrefactor: Internal restructuring with no behavior changedocs: Documentation only (README, docs/, inline comments)style: Formatting, whitespace, naming (no logic change)test: Adding or updating testsci: CI pipeline or workflow changesbuild: Build system, Go module dependencieschore: Maintenance, config, toolingrevert: Reverts a previous commitBREAKING CHANGE: Consumers must update their integrationBreaking Changes
None.
Testing
make testpassesmake test-intpasses if integration paths are exercisedmake lintpassesTest evidence / Actions run:
Architectural Checklist
panic()in production paths — usesasserthelpers or wrapped errorstime.Now().UTC()%wlib-commonsimport (circular — see CLAUDE.md)Related Issues
Closes #