#3040 - Provide additional logging #3375
Conversation
…ovide-informative-errors-for-users-and-developers
auto-assign
bot
requested review from
OlgaMazurina,
urszula-gawlowska and
yuleicul
| window.console.warn(warning); | ||
| } | ||
|
|
||
| static error(error: unknown): void { |
There was a problem hiding this comment.
Could you, please, clarify the difference between error and showExceptionLocation? What is the difference between error and exception?
My proposal is to have only one method error, which can work like this:
KetcherLogger.error('someFile::someFunction', error); – please, note that error can be an object
| @@ -26,7 +27,11 @@ export function identifyStructFormat( | |||
| if (JSON.parse(sanitizedString)) { | |||
| return SupportedFormat.ket; | |||
| } | |||
| } catch (er) {} // eslint-disable-line | |||
| } catch (er) { | |||
| KetcherLogger.showExceptionLocation( | |||
There was a problem hiding this comment.
General comment for everywhere – to pass exception to logger. If someone has any error, then you'll be able to find the place, where error has occurred, but won't be able to understand the error it self.
example/src/App.tsx
Outdated
| @@ -71,6 +73,13 @@ const App = () => { | |||
| structServiceProvider={structServiceProvider} | |||
| onInit={(ketcher: Ketcher) => { | |||
| window.ketcher = ketcher; | |||
|
|
|||
| KetcherLogger.settings = { | |||
There was a problem hiding this comment.
My proposal is to remove this from here. Actually, for 99% of users logger won't be required. It is needed for cases, when we will directly ask customer like "Open the console, write this command, and send logs to us".
So, can you additionally add to description, how logger can be enabled via Dev Tools console?
There was a problem hiding this comment.
To enable logger type in the console:
window.ketcher.logger.enabled = true
The default log level is "ERROR" or 0.
To change log level type in the console:
window.ketcher.logger.level = 1 to enable warnings
2 to enable infos
3 to enable logs
To show traces on logs and infos, type in the console:
window.ketcher.logger.showTrace = true
| export enum LogLevel { | ||
| ERROR = 0, | ||
| WARN = 1, | ||
| LOG = 2, |
There was a problem hiding this comment.
Can we add a method info here? It can be called this way console.info(). This is just additional method for the same logging, but it will allow you to reduce number of logs by setting proper log level
Nitvex
deleted the
3040-provide-informative-errors-for-users-and-developers
branch
How the feature works? / How did you fix the issue?
(Screenshots, videos, or GIFs, if applicable)
Adds a KetcherLogger class, which can be used to log in dev and prod with specific flags in window.ketcher enabled.
Adds logs to throws so we can see where they happened in prod.
Check list
#1234 – issue name