df1

Type, render and parse the df1 hierarchical structured log format

BSD-3-Clause licensed by Renzo Carbonara

Maintained by renλren.zone

This version can be pinned in stack with:df1-0.4.1@sha256:aa8e84ac9e2492f022de0841c840cd5a53d356377ff8eadfb8ea91e5c3c72169,1104

Depends on 6 packages(full list with versions):

Used by 2 packages in nightly-2023-03-28(full list with versions):

Hierarchical structured logging format. Easy for humans, fast for computers.

This library provides types, parsers and renderers for df1.

Consider this a preview release: The API is likely to stay stable, but extensive testing, formalization and tooling is due.

See the BSD3 LICENSE file to learn about the legal terms and conditions for this library.

Changes

Add ToPath, path.
Add ToValue instances for base’s Char, Fixed; for time’s SystemTime, UTCTime, CalendarDiffDays, CalendarDiffTime, Day, TimeZone, TimeOfDay, LocalTime, ZonedTime, NominalDiffTime, DiffTime, DayOfWeek.
Add ToSegment instances for base’s Char.
Add ToKey instances for base’s Char.
Add Read instance for Level.

COMPILER ASSISTED BREAKING CHANGE: Change functions names Df1.render to Df1.Render.log, Df1.renderColor to Df1.Render.logColorANSI, and Df1.parse to Df1.Parse.log.
Exported key, message, iso8601, segment and value from module Df1.Render.

The segment, key, value and message functions are now methods of the new ToSegment, ToKey, ToValue and ToMessage classes. Identity instances, as well as instances for String, lazy Text and strict Text, have been introduced for these classes.

BREAKING CHANGE: Segment, Key, Value and Message don’t strip surrounding whitespace anymore. When rendering Segment, Key and Value, the whitespace will be percent-encoded. When rendering Message, the whitespace will be kept as is.
BREAKING CHANGE: Segment and Key now wrap lazy Text, rather than strict Text. This is to align their APIs with Value and Message, which already wrapped lazy Text so as to prevent logged Values and Messages from to use much memory. It’s unlikely that Segments and Keys are affected by this, since in practice they are almost always created statically. So, this change is mostly to make the API less surprising to users: Lazy Text is used throughout.
Added draft BNF specification.

Fixed escaping of control characters in Message.
Percent-escape less punctuation characters when rendering Key, Segment and Value.

TODO: write spec.

Consider this a preview release: The API is likely to stay stable, but extensive testing, formalization and tooling is due.