serilog-sinks-map icon indicating copy to clipboard operation
serilog-sinks-map copied to clipboard

docs: Add cleanup policy overview

Open julealgon opened this issue 5 years ago • 1 comments

The main documentation for this sink does not properly explain how the sinks are cleaned up once the limit is reached. I spent some time looking at the code to see how it was disposing the sinks because this was important to my application from a performance standpoint.

Can we add more information related to the cleanup process:

  • Is the process deterministic?
  • In what order are sinks disposed once the limit is reached?
  • Does the cleanup happen asynchronously, or synchronously?
  • When exactly cleanup attempts are made? Before or after the next event is logged?

Having this information upfront would've saved me a few hours of testing and investigation, so I believe this could prove useful for other folks as well.

julealgon avatar Feb 06 '20 21:02 julealgon

Hi Juliano,

Thanks for investigating! Yes, this documentation would be useful/welcome, thanks 👍

nblumhardt avatar Feb 06 '20 23:02 nblumhardt

Closing this one as stale; doc contributions still welcome if anyone's interested in picking it up.

nblumhardt avatar Jul 10 '24 07:07 nblumhardt