Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation of LogBackend configuration #74

Open
straight-shoota opened this issue Nov 28, 2020 · 0 comments
Open

Improve documentation of LogBackend configuration #74

straight-shoota opened this issue Nov 28, 2020 · 0 comments
Labels

Comments

@straight-shoota
Copy link
Contributor

The readme and API docs show which options exist to configure LogBackend. But it's not clear what they mean or what the default behaviour is.

From reading the code I assume that by default LogBackend doesn't actually log anything. You need to set capture_exceptions: true to capture log entries with exceptions or capture_all: true to capture every log entry.

I presume both settings together don't really make sense? When capture_all: true the value of capture_exceptions doesn't matter. So maybe it would be better to unify those configuration values to a single option with different levels (as an enum)?
Also - if my assumption about not logging anything by default is correct, wouldn't it be more sensible to log at least exceptions if you don't configure anything? What else would be the point of hooking up a LogBackend?

@Sija Sija added the docs label Oct 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants