Skip to content

Commit 2828ab1

Browse files
committed
Add fine-tuning section to README
1 parent 43c85c8 commit 2828ab1

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,16 @@ options:
6464
- `:levels` - a set of log levels (or `:all`) to limit the appender to
6565
- `:path` - the path of the log file
6666

67+
### Fine-tuning
68+
69+
There are a number of other options for fine-tuning the logger:
70+
71+
- `:buffer-size` - the size of the logging ring buffer (default: 1024)
72+
- `:polling-rate` - the delay in ms between each poll (default: 5)
73+
- `:poll-chunk-size` - the max no. of logs to process each poll (default: 8)
74+
- `:shutdown-delay` - the delay in ms before shutting down (default: 100)
75+
- `:shutdown-timeout` - the time to wait in ms for shutdown (default: 1000)
76+
6777
## License
6878

6979
Copyright © 2024 James Reeves

0 commit comments

Comments
 (0)