Skip to content

Commit

Permalink
Update docs for cacheDir and logging changes (#453)
Browse files Browse the repository at this point in the history
- change default max log file size to 8MB
  • Loading branch information
srics authored Jul 30, 2024
1 parent 4017b97 commit 10fe3b1
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
8 changes: 6 additions & 2 deletions docs/gh_pages/docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,10 @@ Notes:

### Logging

- `level`: Sets the logging level for the Pebblo application. Possible values are 'info', 'debug', 'error', 'warning', and 'critical'.
- `level`: Sets the logging level. Possible values are 'info', 'debug', 'error', 'warning', and 'critical'. Default value is `info`.
- `file`: Sets the log file path. Default value is `/tmp/logs/pebblo.log`.
- `maxFileSize`: Sets the maximum size of the log file. Default value is `8306688` bytes (8 MB).
- `backupCount`: Sets the number of backup files to keep. Default value is `3`.

### Reports

Expand All @@ -30,7 +33,8 @@ Notes:
![Pebblo Reports](../static/img/report-comparision.png)

- `outputDir`: Defines the directory where generated reports will be saved.
- `cacheDir`: Sets the directory where pebblo stores metadata, generated reports, and other temporary files. Default value is `~/.pebblo`.
- `outputDir`: Deprecated. Use `cacheDir` instead.

### Classifier

Expand Down
2 changes: 1 addition & 1 deletion pebblo/app/config/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ class ReportConfig(BaseSettings):

# Logging Defaults
DEFAULT_LOGGER_NAME = "pebblo"
DEFAULT_LOG_MAX_FILE_SIZE = 2 * 1024 * 1024
DEFAULT_LOG_MAX_FILE_SIZE = 8 * 1024 * 1024
DEFAULT_LOG_BACKUP_COUNT = 3
DEFAULT_LOG_LEVEL = "INFO"
DEFAULT_LOG_FILE_PATH = "/tmp/logs"
Expand Down

0 comments on commit 10fe3b1

Please sign in to comment.