fog

Overview

Welcome to Fog! There's a better name for this, I just haven't thought of it yet.

Fog is a slog-API-compatible logging package with a focus on user-facing, or "at the terminal", logging. This is to say: a primary focus is in-the-terminal readability. Fog makes use of ANSI colors to give your eyes clear markers to jump across when quickly scanning log output. It's also more customizable, allowing all log decorations to be toggled. It's also faster!

Who is this for?

Fog might work for you if:

• You're implementing user-facing logging (command-line tooling, for example).
  • Fog allows tuning of all log decorations. Shipping to users: set flags to 0 and you get only clear log message output. Need to debug: set flags appropriately and you've got call stack, level and more.
• Standard log mostly satisfies for your use-case, but man.. I still want log levels.
• After deciding you want log levels, you try slog and find yourself writing slog.Error(... followed by an os.Exit(1) all over the place.
• After the previous two items, you then say, "Well I'll just create this little package I can use to arrive at a sort of slog.Fatal.
• After the previous three items, you decide to just wrap the slog.Logger into your own thing. But wait! Then your program counters for your call sites are all wrong!
• After the previous four items: go get git.sr.ht/~illbjorn/fog and hakuna matata!

How does the performance of Fog compare to Slog?

In my own local benchmarks it's about ~2-3x faster than slog on average. But please bench it yourself! Checkout the repo and run task bench (install Task first if needed)

TODO

• Need to unit test basically everything! But it is developed super iteratively and is holding up just fine in my own projects, fwiw.
• Need to implement some structured logging handlers! Right now only the textHandler is available, but JSON is coming soon!