sema-engine icon indicating copy to clipboard operation
sema-engine copied to clipboard

More descriptive logging from maxi processor

Open smilo7 opened this issue 4 years ago • 1 comments

Logs from maxi-processor when using createOutputChannel in the JavaScript window in sema are not very descriptive. Currently it just says "done"and "buffer received". When it comes to displaying them in the console widget it would be good to change these to something like output channel created, and perhaps the channel number, so that the user is better aware of what is happening.

smilo7 avatar Jul 16 '21 15:07 smilo7

Good point, @smilo7 we do need to look into that more carefully.

It would be good to have a holistic log message design process. We could start by listing all the possible messages and message-triggering scenarios we have so far.

Some additional points to consider:

  • color-code message types (log, info, warning, etc)
  • design message protocol headers (source)
  • look into established logging practices (e.g. python .net)

frantic0 avatar Jul 20 '21 16:07 frantic0