Skip to content

Commit 8d2e127

Browse files
committed
=doc how it goes together
1 parent 3a1140a commit 8d2e127

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,20 @@ logger = global_logger()
3434

3535
# Loggers introduced by this package:
3636

37+
38+
This package introduces 3 new loggers.
39+
The `DemuxLogger`, the `FilteredLogger` and the `FileLogger`.
40+
All of them just wrap existing loggers.
41+
The `DemuxLogger` sends the logs to multiple different loggers.
42+
The `FilteredLogger` lets you add rules to cause a logger to ignore some inputs.
43+
44+
45+
By combining `DemuxLogger` with `FilteredLogger`s you can arbitrarily route log messages, wherever you want.
46+
47+
The `FileLogger` is just a convience wrapper around the base julia `SimpleLogger`,
48+
to make it easier to pass in a filename, rather than a stream.
49+
50+
3751
## `DemuxLogger` and `FileLogger`
3852

3953
The `DemuxLogger` sends the log messages to multiple places.

0 commit comments

Comments
 (0)