log4cats icon indicating copy to clipboard operation
log4cats copied to clipboard

Better documentation

Open zchbndcc9 opened this issue 6 years ago • 5 comments

It would be very nice if there was some more documentation all of the logger apis that are available for use as well as some beginner friendly examples with explanation.

zchbndcc9 avatar Jul 23 '19 19:07 zchbndcc9

Plz up

MaximeGratens avatar Jul 27 '20 13:07 MaximeGratens

It's not obvious from the README what the actual output of that code is.

Ideally logging is always executed and written to disk even if something afterwards blows up inside the program so you can debug it. Whilst side-effects are bad, you can't undo time spent by the cpu so for this reason I assume all log lines are written to disk immediately?

philliptaylorpro avatar Aug 05 '20 15:08 philliptaylorpro

@philliptaylorpro Which backend are you referring to? In Slf4j backend, that depends on how the base logger is configured. They are immediately submitted to the backend logger. However then that logger controls when the unit is returned back to the algebra.

ChristopherDavenport avatar Aug 05 '20 18:08 ChristopherDavenport

I have some ideas for improving the documentation. The testing/noop/writer loggers, structured logging, self aware logging - each of these could get a section. I can spend some time on this (just a couple sentences each, probably everything can fit on the main page of the microsite).

kubukoz avatar Jun 30 '21 16:06 kubukoz

Did any of this planned documentation end up getting added?

yamin-oanda avatar Nov 23 '22 04:11 yamin-oanda