Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add documentation on log level #264

Merged
merged 2 commits into from
Feb 16, 2021
Merged

Add documentation on log level #264

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce6268f
Add documentation on log level
Feb 16, 2021
9e1cd6c
Merge branch 'main' into doc_log_level
eliecharra Feb 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion doc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,24 @@ When a crash occurs in driftctl, we do not send any crash reports.
For debugging purposes, you can add `--error-reporting` when running driftctl and crash data will be sent to us via [Sentry](https://sentry.io)
Details of reported data can be found [here](./cmd/flags/error-reporting.md)

#### Log level

By default driftctl logger only displays warning and error messages. You can set `LOG_LEVEL` environment variable to change the default level.
Valid values are : trace,debug,info,warn,error,fatal,panic.

**Note:** In trace level, terraform provider logs will be shown.

Example

```shell
$ LOG_LEVEL=debug driftctl scan
DEBU[0000] New provider library created
DEBU[0000] Found existing provider path=/home/driftctl/.driftctl/plugins/linux_amd64/terraform-provider-aws_v3.19.0_x5
DEBU[0000] Starting gRPC client alias=us-east-1
DEBU[0001] New gRPC client started alias=us-east-1
...
```

### Usage

- Commands
Expand All @@ -24,4 +42,4 @@ Details of reported data can be found [here](./cmd/flags/error-reporting.md)

## Issues

- [Known Issues & Limitations](LIMITATIONS.md)
- [Known Issues & Limitations](LIMITATIONS.md)
eliecharra marked this conversation as resolved.
Show resolved Hide resolved