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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a more descriptive logging message #43

Closed
2 tasks
ameliav opened this issue Sep 13, 2023 · 1 comment 路 Fixed by #46
Closed
2 tasks

Add a more descriptive logging message #43

ameliav opened this issue Sep 13, 2023 · 1 comment 路 Fixed by #46
Assignees
Labels
improvement This issue or pull request will add or improve functionality, maintainability, or ease of use

Comments

@ameliav
Copy link
Contributor

ameliav commented Sep 13, 2023

馃挕 Summary

Add a more descriptive logging message.

Motivation and context

This would be useful because the current logging message is non-descriptive and non-specific and will not be able to be differentiated from other reports generated.

Implementation notes

Example of current logging message: 2023-09-13 16:00:26,354 INFO Report generated successfully.
Example of future logging message: 2023-09-13 16:00:26,354 INFO Report [ASSESSMENT_ID] generated successfully to [OUTPUT_DIRECTORY].

Acceptance criteria

How do we know when this work is done?

  • We have decided on what the output message will look like.
  • Log message as been updated.
@ameliav
Copy link
Contributor Author

ameliav commented Sep 13, 2023

I have split issue #28 to two parts because the output is not exactly same and the logging message has not yet been decided.

@ameliav ameliav added the improvement This issue or pull request will add or improve functionality, maintainability, or ease of use label Sep 13, 2023
@ameliav ameliav self-assigned this Sep 15, 2023
@ameliav ameliav linked a pull request Sep 15, 2023 that will close this issue
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improvement This issue or pull request will add or improve functionality, maintainability, or ease of use
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant