More descriptive logging from maxi processor

frantic0 / sema-engine

A Signal Engine for a Live Code Language Ecosystem

https://frantic0.github.io/sema-engine/

MIT License

31 stars 6 forks source link

More descriptive logging from maxi processor #11

Open smilo7 opened 3 years ago

smilo7 commented 3 years ago

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.

frantic0 commented 3 years ago

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)