Extensive documentation

[bzikarsky]

Currently the documentation is almost non existent. This should be changed.

• [ ] Explain architecture with comprehensive examples
• [ ] Explain integration into monolog
• [ ] Update README with links to new docs

[bzikarsky]

ReadTheDocs viable?

[HMAZonderland]

Documenting things is never fun, I see. :-)

[bzikarsky]

Oh well... 🙁 -- Well deserved critism...

[drzraf]

If we assume a monolog config (README.md), it seems that sample configuration is larger than strictly necessary:

• Why not using { type: gelf, publisher: {id: @id-of-publisher } }?
• Couldn't ignore_error_transport be replaced by whatfailuregroup?

On a semi-related note, I found that simply authenticating to a Gelf endpoint (for OVH, using Tcp rather than Http), currently needs its own bundle instead of having a flexible processor for that purpose within gelf-php itself even though it's just about appending some data. There is that Logger::$defaultContext but I didn't see a way to hook it from monolog-bundle configuration.

[pscheit-lillydoo]

a monolog bundle configuration would be handy

[bzikarsky]

I haven't worked with Symfony/Monolog in quite some time, I'm happily welcoming PRs with better docs. :)