feat: enable debug logging via env variable #294
Conversation
🦋 Changeset detectedLatest commit: fdd292b The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
john-u
force-pushed
the
feat-easy-debug
branch
2 times, most recently
from
6f33072 to
7a5319b
Compare
| get logger(): log4js.Logger { | ||
| if (!this._logger) { | ||
| this._logger = log4js.getLogger('cli') | ||
| this._logger = log4js.getLogger(`cli.${this.constructor.name}`) |
There was a problem hiding this comment.
This gives us some runtime context for free via log4js "Categories inheritance". All logs will be routed to the default category, or to the cli category if defined.
packages/cli/README.md
Outdated
| Debug logging can be enabled via the `ST_DEBUG` environment variable. This will log at debug level to the console as well as the default log file. | ||
|
|
||
| ```console | ||
| ST_DEBUG=true smartthings <command> |
There was a problem hiding this comment.
I used SMARTTHINGS_PROFILE for the environment variable used to set the profile and SMARTTHINGS_TOKEN for one that can be used for tokens. We should probably stick to spelling out SMARTTHINGS or change those to match this format.
There was a problem hiding this comment.
I will switch to SMARTTHINGS_DEBUG.
packages/cli/doc/configuration.md
Outdated
| * rest-client - This category is used for the SDK that interfaces with the API. | ||
| Turn this on to see detailed information for HTTP calls are made to SmartThings. | ||
| * cli - This is the generic logger used by the CLI. | ||
| * `cli` - Generic logger used by the CLI. Log entries will have the Command name appended. (ex. `cli.DriversCommand`) |
There was a problem hiding this comment.
Did you mean to capitalize "Command" here?
2 participants
Checklist
npm run lintproduces no warnings/errors)