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

Logging can be more comprehensive #209

Closed
ardunn opened this issue Mar 25, 2021 · 0 comments · Fixed by #296
Closed

Logging can be more comprehensive #209

ardunn opened this issue Mar 25, 2021 · 0 comments · Fixed by #296

Comments

@ardunn
Copy link
Collaborator

ardunn commented Mar 25, 2021

For small operations, including when files fail in a batch operation, very little relevant data is printed to console or can be shown.

For example, batch processing a bunch of runs where one fails, the only error that is returned is shown in the processed json output, which says "insufficient data". We can instead save the stack trace and return that in json.

Another example: A warning can be logged if determine_structuring_parameters does not find a diagnostic. If someone is expecting their files to have a diagnostic, and beep isn't structuring them correctly, this is useful information.

Additionally, we can set logging levels for smaller operations (showing things like what the structuring parameters are when they are determined) to DEBUG or INFO (not important). We can similarly set batch operation logging (whether a file was successful or failed) by setting their log level higher (WARNING or ERROR); these logging ops can be filtered easily by the logging module.

The end result would be logging that is both complete (high res) yet not overwhelming (can be filtered).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
1 participant