feat: add configurable logLevel to install options

[hitarth-gg]

Description of Change

• Added Logger class with logLevel option.
• Updated devtron.install(options) to configure the logger automatically, allowing users to set a minimum log level. Only logs at the selected level and above will be shown, preventing unwanted Devtron logs from cluttering the terminal.
• Updated docs with usage example and options table.

Usage:

await devtron.install({ logLevel: 'warn' }); // only logs 'warn' and 'error'

[erickzhao]

API-wise, I think a logLevel option would make more sense and cover all our bases.

Options would be debug, info, warn, error, or none, where enabling a less important log level would make all higher-priority ones.

It feels more ergonomic that way since you don't usually want to ignore non-contiguous log levels.

[samuelmaddock]

Agreed with @erickzhao about a logLevel option. Then these two examples could be

devtron.install({ logLevel: [] })
devtron.install({ logLevel: ['info', 'warn'] })

I'm partial to the idea of the quiet option as a shorthand though. Open to either keeping it or removing it.

[erickzhao]

In my head it'd look more like a sliding scale:

devtron.install({ logLevel: 'quiet' }) // or `'none'`
devtron.install({ logLevel: 'error' }) // only shows `error`
devtron.install({ logLevel: 'warn' }) // shows `warn`, or `error`, but not `debug` or `info`
devtron.install({ logLevel: 'info' }) // shows `info`, `warn`, or `error`, but not `debug`

since it'd be unlikely that you would want to specifically ignore non-contiguous log levels (e.g. ignoring error and debug but not info and warn).

[hitarth-gg]

@erickzhao I made the requested changes and also updated the NPM Package to 0.0.0-development.15 to reflect the commits above.

[erickzhao]

I think we could combine this and the LogLevel type in src/types/shared.ts if we just make LogLevel into a numeric enum:

enum LogLevel {
  none,
  debug,
  info,
  warn,
  error
}

Enums without assigned values in TS auto-assign to incrementing number values so you can get > comparisons out of the box without defining a separate map.

See:

• TypeScript docs: https://www.typescriptlang.org/docs/handbook/enums.html#numeric-enums
• Playground: https://www.typescriptlang.org/play/?#code/KYOwrgtgBAMg9gcxsAbsANlA3gKCvqAE2ACMwEAaPAgSxADM4qCoB3AQwCcQ7Lr9gnTnE44AvjhwBjOCADOAFyj0wIKAF4oACmAAuWImRp0ASg0A+bPygz5cdMAB06RDqiX4SVBkfEyCEwBucUkcFRAtTyMfOkYTMNVIw290X1JyEyA

[hitarth-gg]

Since we want users to be able to pass log level as a string, like devtron.install({ logLevel: 'warn' }), I'll need to create another type with log level strings as well, right ?

stale

[hitarth-gg]

I've added the LogLevel enum. Let me know if it still doesn’t look right!

[continuous-auth]

🎉 This PR is included in version 2.1.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀