Skip to content

Commit 4765cf8

Browse files
committed
#94: Modifications recommended from Dietmar Aust.
1 parent e151fa4 commit 4765cf8

1 file changed

Lines changed: 6 additions & 1 deletion

File tree

docs/Best Practices.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,12 @@ By default, Logger is configured to delete all `debug` level calls after 7 days.
109109
###Information
110110
`logger.log_info[rmation]` should be used for messages that need to be retained at a higher level than `debug` but are not actionable issues.
111111

112-
Information logging will vary in each organization but should fall between the rules for `debug` and `warning`. An example is to use it in a scheduled job that runs each night at the start and end of the block to highlight that the job was actually run with no errors.
112+
Information logging will vary in each organization but should fall between the rules for `debug` and `warning`. An example is to use it for a long running process to highlight some of the following items:
113+
114+
- When did the process start
115+
- Major steps/milestones in the process
116+
- Number of rows processed
117+
- When did the process end
113118

114119
###Warning
115120
`logger.log_warn[ing]` should be used for non-critical system level / business logic issues that are actionable. If it is a critical issue than an error should be raised and `logger.log_error` should be called. An example would be when a non-critical configuration item is missing. In this case a warning message should be logged stating that the configuration option was not set / mssing and the deafult value that the code is using in place.

0 commit comments

Comments
 (0)