Update sampling APIs, examples, and docs assets#2
Conversation
- Added new examples for `net/http`, `gin`, `fiber v2`, `fiber v3`, and `echo` using `slog` for structured logging. - Included runnable reference applications in `cmd/examples`. - Improved organization of the "More Examples" section for better clarity.
…mpling configuration
- Modified `options.go` to clarify the default behavior of `SamplingRate`.
- Updated all example applications to use a consistent request route format: `/users/{id}`.
- Enhanced error handling and logging in each example to support debugging and failure scenarios.
- Adjusted server ports for each example to avoid conflicts and ensure clarity in usage.
…stom samplers, and ensure TestSink deep copies event fields.
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 WalkthroughWalkthroughThis pull request introduces a composable sampling framework for request filtering, adds event accessor helper functions, and expands example programs across multiple adapters and routers with enriched logging handlers following a consistent request pattern (/users/{id} with context enrichment, debug controls, and failure simulation). Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
🤖 Fix all issues with AI agents
In `@cmd/examples/adapter-slog/main.go`:
- Line 17: Replace the placeholder message "Yooooo" in the hc.Config passed to
stdhappycontext.Middleware with a meaningful, descriptive message (for example
"request handled" or "http request") so the example is clear; locate the call
creating mw (mw := stdhappycontext.Middleware(hc.Config{Sink: sink,
SamplingRate: 0.1, Message: "Yooooo"})) and update the Message field to a
production-ready string.
In `@cmd/examples/adapter-zerolog/main.go`:
- Around line 20-36: The route string passed to hc.SetRoute does not match the
registered mux pattern; update the call to hc.SetRoute in the handler so it uses
the same pattern syntax as mux.HandleFunc (i.e., replace "/users/:id" with
"/users/{id}") so SetRoute and the registered route are consistent; locate the
handler registered with mux.HandleFunc("/users/{id}", ...) and change the
argument to hc.SetRoute accordingly.
In `@cmd/examples/sampling-custom/main.go`:
- Around line 28-30: The sampler uses hc.EventFields which calls e.snapshot(),
but event_access.go exposes incorrect accessor names so e.snapshot() doesn't
exist/compile; open event_access.go and rename or add the correct methods so the
Event type implements snapshot() (and any other expected accessors) with the
proper receiver and signature, rebuild to ensure hc.EventFields compiles and the
tier assertion in this file is valid; reference hc.EventFields, e.snapshot(),
and event_access.go while making the fixes.
In `@README.md`:
- Around line 121-342: The README "More Examples" inline snippets use port
values that differ from the runnable apps in cmd/examples (e.g., snippets "2.
gin + slog", "5. echo + slog", "6. net/http + zap", "7. net/http + zerolog" use
:8102, :8103, :8092, :8093 while cmd/examples uses :8105, :8106, :8092, :8093);
either unify the port numbers so the snippets match the corresponding
cmd/examples apps or add a clear one-line note above the examples stating that
the inline snippets are standalone and intentionally use different ports than
the cmd/examples directory, and update the snippet summaries (e.g., "2. gin +
slog", "3. fiber v2 + slog", etc.) to reference the chosen approach so readers
aren’t confused.
- Line 65: The call to http.ListenAndServe(":8080", mw(mux)) is placed outside
the func main() block; move or indent that line so it lives inside the main
function's braces and is properly indented, ensuring mw and mux are in scope
(i.e., place the ListenAndServe call within the body of func main where mux and
mw are defined and format with the same indentation style as surrounding
statements).
🧹 Nitpick comments (3)
cmd/examples/sampling-custom/main.go (1)
48-50:time.Sleepon the request goroutine is fine for a demo, but consider a brief inline comment.A short comment like
// simulate slow upstream callwould clarify intent for users reading this example as reference material.sampling.go (1)
69-81: Clamping negativeminDurationto zero makesKeepSlowerThankeep all requests.When
minDurationis negative it is clamped to0, butin.Duration >= 0is always true for real-world request durations, so the middleware silently becomes anAlwaysSampler. Consider clamping to 0 and returning the passthrough (next) middleware instead, or documenting this edge-case more explicitly.Suggested approach
func KeepSlowerThan(minDuration time.Duration) SamplerMiddleware { if minDuration < 0 { minDuration = 0 } + if minDuration == 0 { + return func(next Sampler) Sampler { return next } + } return func(next Sampler) Sampler { return func(in SampleInput) bool { return in.Duration >= minDuration || next(in) } } }cmd/examples/sampling-inbuilt/main.go (1)
15-38: Example clearly demonstrates the composable sampling API.Good showcase of
ChainSamplerwith rate limiting, error retention, path-prefix, and latency-based sampling all wired together. The two routes effectively exercise different sampling paths.One minor nit:
_ = http.ListenAndServe(...)silently discards bind/listen errors. For examples,log.Fatal(http.ListenAndServe(...))is more idiomatic and helps users debug port conflicts.Optional tweak
- _ = http.ListenAndServe(":8109", mw(mux)) + log.Fatal(http.ListenAndServe(":8109", mw(mux)))(requires adding
"log"to imports)
| fields := hc.EventFields(in.Event) | ||
| tier, _ := fields["user_tier"].(string) | ||
| return tier == "enterprise" |
There was a problem hiding this comment.
hc.EventFields depends on the broken accessors in event_access.go — this sampler won't work until that's fixed.
EventFields calls e.snapshot() which doesn't compile (see review on event_access.go). Once those method names are corrected, this usage will work correctly — the nil-map type assertion on Line 29 is safe.
🤖 Prompt for AI Agents
In `@cmd/examples/sampling-custom/main.go` around lines 28 - 30, The sampler uses
hc.EventFields which calls e.snapshot(), but event_access.go exposes incorrect
accessor names so e.snapshot() doesn't exist/compile; open event_access.go and
rename or add the correct methods so the Event type implements snapshot() (and
any other expected accessors) with the proper receiver and signature, rebuild to
ensure hc.EventFields compiles and the tier assertion in this file is valid;
reference hc.EventFields, e.snapshot(), and event_access.go while making the
fixes.
1 participant
refine sampling configuration and example usage across the package
Summary by CodeRabbit
New Features
Documentation