Skip to content

Commit 36ac89a

Browse files
dingsdaxclaude
andcommitted
docs(yabeda): Add How it works section to README
Explain the two metric modes: inline metrics (counters, histograms, summaries, direct gauge sets) forward to Sentry immediately, while collector blocks need a periodic trigger since Yabeda was designed for Prometheus's pull model. Documents the 15s background thread and the lack of trace context on collector-driven metrics. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 39ca600 commit 36ac89a

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

sentry-yabeda/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,9 @@ end
3939
```
4040

4141
That's it! All Yabeda metrics will automatically flow to Sentry.
42+
43+
## How it works
44+
45+
Counters, histograms, summaries, and directly-set gauges all forward to Sentry inline when your app calls them. Yabeda summaries map to Sentry distributions, as Sentry has no summary type.
46+
47+
Collector blocks (`Yabeda.configure { collect { ... } }`) are Yabeda's pull hook — in Prometheus they're triggered by a scrape request. Since Sentry is push-based, `sentry-yabeda` runs a background thread that calls `Yabeda.collect!` every 15 seconds. Metrics populated this way (typically gauges for GC stats, thread counts, etc.) won't carry trace context.

0 commit comments

Comments
 (0)