coder / slog
96%

DEFAULT BRANCH: main
Repo Added
Token RwaFMiyeLjsSbbPvnzRlCGnFaUGTPofYK regen
Build 169 Last
Files 12
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst

LAST BUILD ON BRANCH main
branch: main
CHANGE BRANCH
x
Sync Branches

coverage: 96.08% (+0.05%) from 96.034%
a4f439e455e1db7c96c91b1c24bd5ca561e2df89

push

github

web-flow 
feat: add FlightRecorder sink for deferred low-level logging (#237)

* feat: add Buffer sink for deferred low-level logging

Buffer is a Sink that holds entries below a configured level in a
fixed-size in-memory ring, forwarding entries at or above the level
immediately. Flush replays the buffered entries to the wrapped sinks.

This lets a program run its logger at LevelDebug to capture verbose
entries while only emitting them on demand (e.g. on an error or
connection failure), with a configurable buffer size. When full, the
oldest entry is evicted.

* feat: add Flusher interface for deferred sinks

Flusher (Flush(ctx)) lets callers trigger a flush without depending on
the concrete Buffer type, which is handy when the buffer is created in
one place and flushed in another. Buffer implements it.

* refactor: rename buffer.go and buffer_test.go to flightrecorder.go and
flightrecorder_test.go

* refactor: rename Buffer to FlightRecorder

* refactor: make flight recording a Logger flag with auto-flush on error

Rework the flight recorder from a standalone Buffer/Flusher sink into a
Logger capability. Logger.FlightRecorder(size) enables a rolling
in-memory history of below-level entries; the history is flushed to the
sinks automatically when an entry at LevelError or above is logged, or
manually via Logger.Flush.

Enabling flight recording is independent of the Logger level, so it is
order-independent with Leveled(). Derived loggers (With, Named, Leveled)
share the underlying ring and capture their derived fields and names.

Replace the fill-tracking branch in the ring with a monotonic written
counter: the ring is allocated at full length and writes always land at
written%size, so the write path is branchless and drain derives the
entry count and oldest position from written.

* refactor: track ring position and length instead of unbounded counter

Replace the monotonic written counter with bounded pos and length fields,
so neither grows without limit and t... (continued)

61 of 63 new or added lines in 2 files covered. (96.83%)

956 of 995 relevant lines covered (96.08%)

99.66 hits per line

Relevant lines Covered
995 RELEVANT LINES 956 COVERED LINES
99.66 HITS PER LINE
Source Files on main

Recent builds

Builds Branch Commit Type Ran Committer Via Coverage
a4f439e4... main feat: add FlightRecorder sink for deferred low-level logging (#237) * feat: add Buffer sink for deferred low-level logging Buffer is a Sink that holds entries below a configured level in a fixed-size in-memory ring, forwarding entries at or abov... push web-flow github
96.08
244048fb... main chore: update dependencies for security fixes (#229) push web-flow github
96.03
08c064db... main fix(internal/syncwriter): write diagnostics in a single os.Stderr write (#226) The error handler used the builtin println, which writes to fd 2 unsynchronized with the test stream and emits the message and its trailing newline as two separate sys... push web-flow github
96.03
284c50fc... main fix: render error types as strings in human log sink (#224) `formatValue` checked `reflect.Struct` before checking the `error` interface, so struct-typed errors like `context.DeadlineExceeded` were serialized via `json.Marshal` as `{}` instead of... push web-flow github
96.03
348ac12d... main chore: update to v3 (#223) push web-flow github
96.01
99abaf9e... main fix!: don't panic, only accept typed log Fields (#222) * fix: don't panic, only accept typed log Fields * slogtest errors if we fail to stringify a field value push web-flow github
96.01
40ff1993... main perf: human log sink performance bump via reduction of allocs/total allocated memory (#220) Signed-off-by: Callum Styan <callumstyan@gmail.com> push web-flow github
95.7
9df5e0a6... main fix!: handle `sql/driver.Valuer` types properly in `slogjson` (#219) Currently, if a field like `sql.NullInt32` has `Valid: False`, `sloghuman` will export it's value as `<nil>`, regardless of it's `String`. This is because it checks `(driver.Va... push web-flow github
96.82
0ec81e6e... main feat: add IgnoreErrorFn to slogtest options (#217) Signed-off-by: Spike Curtis <spike@coder.com> push web-flow github
97.04
3e5cea5e... main ci: fix lint, fmt and upload artifacts (#218) * chore(.github): update actions/upload-artifacts push web-flow github
97.01
See All Builds (169)

Badge your Repo: slog

We detected this repo isn’t badged! Grab the embed code to the right, add it to your repo to show off your code coverage, and when the badge is live hit the refresh button to remove this message.
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst

Refresh