Make logging more customization friendly #2320
Conversation
cmarqu
added
type:feature
Codecov Report
@@ Coverage Diff @@
## master #2320 +/- ##
==========================================
+ Coverage 73.98% 74.15% +0.17%
==========================================
Files 36 36
Lines 6492 6505 +13
Branches 557 556 -1
==========================================
+ Hits 4803 4824 +21
+ Misses 1501 1495 -6
+ Partials 188 186 -2
Continue to review full report at Codecov.
|
cmarqu
force-pushed
the
log-improvements
branch
13 times, most recently
from
1a4e0b9
to
e10d728
Compare
cmarqu
removed
the
status:needs-newsfragment
cmarqu
force-pushed
the
log-improvements
branch
3 times, most recently
from
c74be19
to
e70da93
Compare
|
I am not sure if this is the right place to comment. But out default logging, especially (multiple lines per log message) makes it harder to handle in any kind of parsing/post processing. |
|
Note that this PR doesn't change the default log format at all. This PR would actually make it easier to set up a (additional) logger that is parser-friendly. |
|
I suppose it could be said that the new functions for sub-elements of the log line should be marked private so that we do not commit to them being stable until formally deprecated. |
| if len(string) > chars: | ||
| return ".." + string[(chars - 2) * -1:] | ||
| return "".join(["..", string[(chars - 2) * -1:]]) |
There was a problem hiding this comment.
The truncation should be more configurable, for instance, we could use the ellipsis … to save one character.
cmarqu
force-pushed
the
log-improvements
branch
from
e70da93
to
3b25f3c
Compare
in the log module, introduce new functions format_sim_time(), format_recordname(), format_filename(), format_funcname(), format_exc_msg(), format_build_line(). The added overhead for using these function calls to format the single log line elements is (over-)compensated by introducing LRU caching. Add a custom_logger example that shows how to add visual "brackets" to simulator timestamps.
cmarqu
force-pushed
the
log-improvements
branch
from
3b25f3c
to
a8dd531
Compare
There was a problem hiding this comment.
The point of this seems to be adding a couple hooks to tweak the existing log formatter, but is incapable of adding or deleting information, or changing order of the elements of a log line. cocotb's code is MIT licensed, any user could copy-paste the formatter and change it in more ways that this change provides. I don't see the value.
The added overhead for using function calls to format the single
log line elements is compensated by introducing LRU caching.
Add a custom logger test that adds visual brackets to sim timestamps.