Skip to content

Commit

Permalink
docs: Minor changes to logging (#1893)
Browse files Browse the repository at this point in the history
  • Loading branch information
Fennerr authored Feb 13, 2023
1 parent 9be753b commit de18c3c
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions docs/tutorials/logging.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Logging

Prowler has a logging feature to be as transparent as possible so you can see every action that is going on will the tool is been executing.
Prowler has a logging feature to be as transparent as possible, so that you can see every action that is being performed whilst the tool is being executing.

## Set Log Level
## Set Log Level

There are different log levels depending on the logging information that is desired to be displayed:

- **DEBUG**: it will show low-level logs of Python.
- **INFO**: it will show all the API Calls that are being used in the provider.
- **WARNING**: it will show the resources that are being **allowlisted**.
- **ERROR**: it will show the errors, e.g., not authorized actions.
- **CRITICAL**: default log level, if a critical log appears, it will **exit** Prowler’s execution.
- **DEBUG**: It will show low-level logs from Python.
- **INFO**: It will show all the API calls that are being invoked by the provider.
- **WARNING**: It will show all resources that are being **allowlisted**.
- **ERROR**: It will show any errors, e.g., not authorized actions.
- **CRITICAL**: The default log level. If a critical log appears, it will **exit** Prowler’s execution.

You can establish the log level of Prowler with `--log-level` option:

Expand All @@ -20,9 +20,9 @@ prowler <provider> --log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL}

> By default, Prowler will run with the `CRITICAL` log level, since critical errors will abort the execution.
## Export Logs to File
## Export Logs to File

Prowler allows you to export the logs in json format with `--log-file` option:
Prowler allows you to export the logs in json format with the `--log-file` option:

```console
prowler <provider> --log-level {DEBUG,INFO,WARNING,ERROR,CRITICAL} --log-file <file_name>.json
Expand All @@ -45,4 +45,4 @@ An example of a log file will be the following:
"message": "eu-west-2 -- ClientError[124]: An error occurred (UnauthorizedOperation) when calling the DescribeNetworkAcls operation: You are not authorized to perform this operation."
}

> NOTE: Each finding is a `json` object.
> NOTE: Each finding is represented as a `json` object.

0 comments on commit de18c3c

Please sign in to comment.