Description
Just a suggestion for the documentation associated with this project.
There is quite a lot of information to digest on an initial first reading.
One thing which I think would be helpful would be to add a summary page which groups objects into categories:
- Log sources
- Log sinks
- Things which sit in the middle of a source and a sink, like a filter
It looks to me as if many of the components from the various packages are designed to work together and be composable. But it isn't necessarily that clear how they can be composed.
For example, apparently a FormatLogger is a sink. But there are several other sinks, for example
FileLoggerDatetimeRotatingFileLoggerConsoleLoggerSimpleLogger
Shouldn't these objects be able to accept a custom format for logging? (They do.) So, should they be able to accept a FormatLogger, because this is an object which is responsible for formatting a sequence of log events?
The answer of course is that these mentioned sinks are formattable, but they do not use a FormatLogger to do so. A FormatLogger itself is a sink, so it wouldn't make much sense for one type of sink to be chained to another type of sink.
Initially, I thought that a FormatLogger was some kind of intermediate object. But it turns out that's not the case.