bitfocus / companion

Bitfocus Companion enables the reasonably priced Elgato Stream Deck and other controllers to be a professional shotbox surface for an increasing amount of different presentation switchers, video playback software and broadcast equipment.
http://bitfocus.io/companion
Other
1.61k stars 503 forks source link

Add milliseconds to log entries #2891

Open phuvf opened 5 months ago

phuvf commented 5 months ago

Is this a feature relevant to companion itself, and not a module?

Is there an existing issue for this?

Describe the feature

I'd prefer log entries to include milliseconds, as I use regularly use this to check:

I'm also assuming the log is chronological, but when a bunch of entries have the same second timestamp, is not explicit what order they actually happened in.

image

Usecases

thedist commented 5 months ago

Just to check, are you aware you can run Companion in dev mode and get better logging (as in, logs in the console not the WebUI) which can be very beneficial for development? It's not a end-user solution, but for developers this may be a good option.

eg, starting Companion with yarn dev this is a snippet of what is logged

2024-06-02T08:54:55.627Z debug Instance/Modules Emotimo-ST4@1.0.4: eMotimo: ST4; ST4.3; SA2.6
2024-06-02T08:54:55.629Z debug Instance/Modules ableset@1.4.1: Leolabs: AbleSet
2024-06-02T08:54:55.640Z debug Instance/Modules adder-1000series@1.0.0: Adder: Infinity 1000R Series
2024-06-02T08:54:55.640Z debug Instance/Modules adder-xdip@2.0.0: Adder: XDIP
2024-06-02T08:54:55.640Z debug Instance/Modules agf-characterworks@2.0.2: AGF: Characterworks
2024-06-02T08:54:55.641Z debug Instance/Modules ai-media-lexi-live@1.1.1: AI Media: Lexi Live
2024-06-02T08:54:55.643Z debug Instance/Modules aja-helo@2.3.0: AJA: HELO
2024-06-02T08:54:55.646Z debug Instance/Modules aja-kipro@3.3.0: AJA: Ki Pro; Ki Pro Ultra
2024-06-02T08:54:55.647Z debug Instance/Modules aja-kumo@2.1.0: AJA: Kumo
2024-06-02T08:54:55.647Z debug Instance/Modules allenheath-ahm@2.0.1: Allen & Heath: AHM

So I can easily see a full timestamp including ms, what log level the message is, where the message is coming from. and it can't be seen here but it's also colour coded.

phuvf commented 5 months ago

Thanks for the heads-up - I wasn't aware of this.

There's been situations when I'm using Companion in production and trying to debug e.g. incoming OSC messages when milliseconds would also be helpful.

I'm assuming they're removed for visual clarity reasons?