You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Hi guys. I would like to put on the table one little suggestion to consider.
It's not a something critical. This is just an idea how to align the application with the existing known logging patterns. It's up to you to decide whether follow this way or not. Don't hesitate to contact me in case of any questions. I also can prepare the corresponding PR if you want.
Feature idea
Generally, I'd recommend to consider the following pattern. It's typically used when we can control log workflow and failing of the pipeline execution.
Currently, the description message and a list of files are logged with the INFO level disregarding on the "fail-on-violation" option.
It would be better to log the violated files with the "ERROR" level in case "fail-on-violation" option is turned on. It helps to highlight an error part better in case the console tool supports it. (For example, such lines will be red).
On the other hand, when "fail-on-violation" option is turned off, you can log violated files with the "WARN" level. It would make a hint for the users that something is not good enough. however pipeline is still working. It might be useful because people rarely watch any successful executions. And even more rarely read the full logs, especially when it contains only white INFO messages.
What do you think about it? Does it make sense?
Looking forward to your reply.
The text was updated successfully, but these errors were encountered:
Intro
Hi guys. I would like to put on the table one little suggestion to consider.
It's not a something critical. This is just an idea how to align the application with the existing known logging patterns. It's up to you to decide whether follow this way or not. Don't hesitate to contact me in case of any questions. I also can prepare the corresponding PR if you want.
Feature idea
Generally, I'd recommend to consider the following pattern. It's typically used when we can control log workflow and failing of the pipeline execution.
Currently, the description message and a list of files are logged with the INFO level disregarding on the "fail-on-violation" option.
It would be better to log the violated files with the "ERROR" level in case "fail-on-violation" option is turned on. It helps to highlight an error part better in case the console tool supports it. (For example, such lines will be red).
On the other hand, when "fail-on-violation" option is turned off, you can log violated files with the "WARN" level. It would make a hint for the users that something is not good enough. however pipeline is still working. It might be useful because people rarely watch any successful executions. And even more rarely read the full logs, especially when it contains only white INFO messages.
What do you think about it? Does it make sense?
Looking forward to your reply.
The text was updated successfully, but these errors were encountered: