Is there a unified logging approach?

[jmenzies12]

Hey there,

I noticed that GLSP-Client has both logger.log and console.log, whereas the server uses logger.log. Do you plan on unifying the different logging methods on the client?

Currently I am setting up winston in order to capture logs (and save to file) from the front-end side of our application and was hoping to be able to override the glsp-client and glsp-vscode-integration logging in order to capture everything together.

Cheers
Jonathan

[tortmayr]

Hi @jmenzies12,

thanks for raising this. Unifying the logging methods on the client and using the sprotty Logger where possible definitely makes sense. I will put this on our road map.

Let's quickly summarize the necessary changes:

• glsp-client:
  • Consistently use the injectable logger over console.log in injectable services
  • For stateless log (i.e. in plain functions) add an optional parameter so that we can pass-through a Logger instance.
• vscode-integration
  • webview: same change as in client
  • extension: Introduce a root level Logger interface and use it over console.log
• server-node:
  Make sure that we consistently use the provide Logger interface over console log
• theia-integration:
  • no changes necessary. console.logs are automatically handled by Theia's logger implementation
• Java-server:
  • Currently no changes necessary. We use standard logging libraries here (log4j)
• Eclipse-integration:
  - server: no changes necessary (log4j)
  - client/webview: same as in glsp-client

[jmenzies12]

Thanks @tortmayr, that all sounds good!

[tortmayr]

I have created #1583 to track this