Fix hierarchical logging documentation #171
Conversation
|
Thanks for the contribution. I think the existing example is too long and seems to be trying to demonstrate a few different things. I think is should be shortened quite a bit in order to just show very simple API usage. This might mean in-lining the sample from the example/ dir, or perhaps just eliding the code sample in the The existing example does look correct however - both the comments in the code and the output as quoted. |
I don't think it's all correct. I've simplified and updated the changes to clarify more about the incorrect behavior/output. |
| @@ -108,34 +108,30 @@ their `onRecord` streams. | |||
| }); | |||
|
|
|||
|
|
|||
| // Will NOT print because FINER is too low level for `Logger.root`. | |||
| // Will NOT print because FINER is too low level for ([LOG1] & [ROOT]). | |||
| log1.finer('LOG_01 FINER (X)'); | |||
There was a problem hiding this comment.
This one is correct, I've just updated the comment to be more clear.
| log1.finer('LOG_01 FINER (X)'); | ||
|
|
||
| // Will print twice ([LOG1] & [ROOT]) | ||
| log1.fine('LOG_01 FINE (√√)'); |
There was a problem hiding this comment.
This one is incorrect.
It should print once by [LOG1] only as the root logger has higher level WARNING.
As per Level definiton, logging level should enable logging only for all levels above the level not below it.
However, the output shows that the root logger fires which is actually a bug https://github.com/dart-lang/logging/issues/145
|
|
||
| // Will print ONCE because `log1` only uses root listener. | ||
| log1.warning('LOG_01 WARNING (√)'); |
There was a problem hiding this comment.
This one is incorrect.
It should print twice as WARNING is sufficient for both [LOG1] & [ROOT], and the output actually print it twice as:
[LOG1][FINE+] LOG_01 WARNING (√)
[ROOT][WARNING+] LOG_01 WARNING (√)
|
|
||
| // Will never print because FINE is too low level. | ||
| // Will NOT print because FINE is too low level for ([LOG1] & [ROOT]). | ||
| log2.fine('LOG_02 FINE (X)'); |
There was a problem hiding this comment.
This one is correct, I've just updated the comment to be more clear.
|
|
||
| // Will never print because FINE is too low level. | ||
| // Will NOT print because FINE is too low level for ([LOG1] & [ROOT]). | ||
| log2.fine('LOG_02 FINE (X)'); | ||
|
|
||
| // Will print twice ([LOG2] & [ROOT]) because warning is sufficient for all | ||
| // loggers' levels. | ||
| log2.warning('LOG_02 WARNING (√√)'); |
|
|
||
| // Will never print because `info` is filtered by `Logger.root.level` of | ||
| // `Level.WARNING`. | ||
| log2.info('INFO (X)'); |
There was a problem hiding this comment.
This one is correct but it's not needed as it's the same case as log2.fine('LOG_02 FINE (X)');
|
Closing as the dart-lang/logging repository is merged into the dart-lang/core monorepo. Please re-open this PR there! |
The hierarchical logging documentation is inaccurate and needs to be updated.
Note: Logging level should enable logging for all levels above that level not below that level.
Contribution guidelines:
dart format.Note that many Dart repos have a weekly cadence for reviewing PRs - please allow for some latency before initial review feedback.