Improve documentation in code and outside code
Opened this issue · 1 comments
Brunni commented
Hi,
I'm very happy about this GELF Logging Extension, as I don't need to use serilog or NLog to get my logs into GrayLog interface.
But I would prefer some more documentation, e.g.
- Is this extension using async or sync logging? Is there a caching?
- What happens, if there are connection errors? Is there a retry or is the extension disabled for some time? Where are the logs?
- Is every message via HTTPS sent as a single request?
Also inside the code:
- Why is this method necessary? Why not use totalseconds?
I don't want to loose log messages, when using this extension and make sure, that everything is configured correctly.
mattwcole commented
This library is one of many 3rd party providers for Microsoft.Extensions.Logging that all work in a similar way. To answer your questions:
- Logging is of course async and there is no no caching (what would be cached?)
- Connection errors are swallowed silently, there are no retries and no internal logs
- Messages are sent according to the GELF specification 1 message at a time
- The
GetTimestamp()
method is used to populate thetimestamp
property in the GELF spec