Benchmark Data

Summary Links

samber/slog-logrus is a wrapper around the pre-existing sirupsen/logrus logging library.

samber/slog-logrus
sirupsen/logrus

Benchmark Data

Score: 8.29

Benchmark	Runs	Ns/Op	Allocs/Op	Bytes/Op	MB/Sec	Score
Attributes	68,683	17,200.00	91	8,503	23.72	0.00
Big Group	1,476	789,574.00	8,259	436,376	33.01	2.65
Disabled	322,712,914	3.72	0	0	0.00	96.86
Key Values	68,218	17,344.00	91	8,505	23.52	0.00
Logging	2,991	402,081.00	2,653	191,964	20.97	0.00
Simple	353,227	3,324.00	26	1,481	21.96	0.00
Simple Source	160,810	7,451.00	59	3,940	35.84	0.00
With Attrs Attributes	45,680	26,203.00	130	13,899	24.65	0.00
With Attrs Key Values	45,476	26,281.00	130	13,901	24.58	0.00
With Attrs Simple	73,255	16,354.00	86	7,397	26.90	0.00
With Group Attributes	57,878	19,881.00	154	14,242	19.01	0.00
With Group Key Values	59,378	20,020.00	154	14,243	18.88	0.00

Benchmark Charts

Warnings

Score: 56.92

Required

EmptyAttributes Empty attribute(s) logged ("":null)

Handlers are supposed to avoid logging empty attributes.

"- If an Attr's key and value are both the zero value, ignore the Attr."

Verify: Attribute With Empty
	{ "": null, "first": "one", "level": "info", "msg": "This is a message", "pi": 3.141592653589793, "time": "2024-05-19T01:15:07Z" }
Verify: Attributes Empty
	{ "": null, "first": "one", "level": "info", "msg": "This is a message", "pi": 3.141592653589793, "time": "2024-05-19T01:15:07Z" }
Verify: Attributes With Empty
	{ "": null, "first": "one", "level": "info", "msg": "This is a message", "pi": 3.141592653589793, "second": 2, "time": "2024-05-19T01:15:07Z" }

GroupInline Group with empty key does not inline subfields

Handlers should expand groups named "" (the empty string) into the enclosing log record.

"- If a group's key is empty, inline the group's Attrs."

Verify: Group Inline
	{ "": { "fourth": "forth", "second": 2, "third": "3" }, "first": "one", "level": "info", "msg": "This is a message", "pi": 3.141592653589793, "time": "2024-05-19T01:15:07Z" }

Resolver LogValuer objects are not resolved

Handlers should resolve all objects implementing the LogValuer or Stringer interfaces. This is a powerful feature which can customize logging of objects and speed up logging by delaying argument resolution until logging time.

"- Attr's values should be resolved."

Verify: Resolve Group
	{ "group": { "hidden": {}, "pi": 3.141592653589793 }, "level": "info", "msg": "This is a message", "time": "2024-05-19T01:15:07Z" }
Verify: Resolve Group With
	{ "group": { "hidden": {}, "pi": 3.141592653589793 }, "level": "info", "msg": "This is a message", "time": "2024-05-19T01:15:07Z" }
Verify: Resolve Valuer
	{ "hidden": {}, "level": "info", "msg": "This is a message", "time": "2024-05-19T01:15:07Z" }
Verify: Resolve With
	{ "hidden": {}, "level": "info", "msg": "This is a message", "time": "2024-05-19T01:15:07Z" }

SlogTest Failure of embedded slog/slogtest

Documentation on building a handler suggests testing using slog/slogtest, part of the Go release since 1.21. While the verification suite includes tests patterned after those in slogtest, an additional single test invokes the slogtest testing sequence (involving multiple tests). Since this is a separate package, all error messages are returned at once. This is the only warning that affects TestSlogTest and all of its error messages.

Verify: Slog Test

unexpected key ""
a Handler should ignore an empty Attr

unexpected key "time"
a Handler should ignore a zero Record.Time

missing key "c"
a Handler should inline the Attrs of a group with an empty key

"k"
got map[string]interface {}{}, want "replaced": a Handler should call Resolve on attribute values

"b"
got map[string]interface {}{}, want "v2": a Handler should call Resolve on attribute values in groups

"k"
got map[string]interface {}{}, want "replaced": a Handler should call Resolve on attribute values from WithAttrs

"b"
got map[string]interface {}{}, want "v2": a Handler should call Resolve on attribute values in groups from WithAttrs

ZeroPC SourceKey logged for zero PC

The slog.Record.PC field can be loaded with a program counter (PC). This is normally done by the slog.Logger code. If the PC is non-zero and the slog.HandlerOptions.AddSource flag is set the source field will contain a slog.Source record containing the function name, file name, and file line at which the log record was generated. If the PC is zero then this field and its associated group should not be logged.

"- If r.PC is zero, ignore it."

Verify: Zero PC
	{ "level": "info", "msg": "This is a message", "source": {}, "time": "2024-05-19T01:15:07Z" }

ZeroTime Zero time is logged

Handlers should not log the basic time field if it is zero.

"- If r.Time is the zero time, ignore the time."

Verify: Zero Time		2024-05-19T01:15:07Z
	{ "level": "info", "msg": "This is a message", "time": "2024-05-19T01:15:07Z" }

Implied

NoReplAttrBasic HandlerOptions.ReplaceAttr not available for basic fields

Some handlers (e.g. phsym/zeroslog) support HandlerOptions.ReplaceAttr except for the four main fields time, level, msg, and source. When that is the case it is better to use this (WarnNoReplAttrBasic) warning.

Verify: Replace Attr Basic		too many attributes: 4 time field still exists msg field still exists source == map[file:/home/runner/work/go-slog/go-slog/verify/tests/replace.go function:github.com/madkins23/go-slog/verify/tests.(*SlogTestSuite).TestReplaceAttrBasic line:89]

Verify: Replace Attr Fn Level Case		level value not null

Verify: Replace Attr Fn Multi
	{ "group": { "alpha": "OMEGA", "pi": 3.141592653589793, "subGroup": { "e": 2.718281828459045, "goober": "snoofus", "la la la": "omega", "oneMore": { "alpha": "omega", "gibbering": "moontic", "phi": 1.618033988749895 } } }, "level": "info", "msg": "This is a message", "time": "2024-05-19T01:15:07Z" }
Verify: Replace Attr Fn Remove Empty Key

Verify: Replace Attr Fn Remove Time		time value not empty string

Suggested

LevelCase Log level in lowercase

Each JSON log record contains the logging level of the log statement as a string. Different handlers provide that string in uppercase or lowercase. Documentation for slog.Level says that its String() and MarshalJSON() methods will return uppercase but UnmarshalJSON() will parse in a case-insensitive manner.

Verify: Canceled Context		'info'

Verify: Canceled Context		'info'

Verify: Canceled Context		'info'

Verify: Key Case		'debug'

Verify: Key Case		'info'

Verify: Key Case		'error'

Verify: Keys		'info'

Verify: Source Key		'info'

Verify: Zero PC		'info'

Verify: Zero Time		'info'

LevelWrong Log level is incorrect

The log level name is not what was expected (e.g. "WARNING" instead of "WARN"). This is different from the LevelCase warning which is from the right level name but the wrong character case.

Verify: Key Case		should be 'WARN', not 'warning'

Handler samber/slog-logrus

Benchmark Data

Benchmark Charts

Warnings