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

Document logger defaults #126

Merged
merged 1 commit into from
Nov 21, 2023
Merged

Document logger defaults #126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions packages/api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ Enables or disables logging. Options:
- `true` - Enables logging.
- `false` - Disables logging.

Default: `true`.

#### `LOG_FORMAT`

The format of the log output. Options:
Expand All @@ -67,6 +69,8 @@ The format of the log output. Options:
- `pretty` - Logs are formatted in a human-friendly "pretty" way. Ideal, when running the service locally and in
development.

Default: `json`.

#### `LOG_COLORIZE`

Enables or disables colors in the log output. Options:
Expand All @@ -75,6 +79,8 @@ Enables or disables colors in the log output. Options:
Recommended when running locally and in development.
- `false` - Disables colors in the log output. Recommended for production.

Default: `false`.

#### `LOG_LEVEL`

Defines the minimum level of logs. Logs with smaller level (severity) will be silenced. Options:
Expand All @@ -84,6 +90,8 @@ Defines the minimum level of logs. Logs with smaller level (severity) will be si
- `warn` - Enables logs with level `warn` and `error`.
- `error` - Enables logs with level `error`.

Default: `info`.

### Configuration file

The API is configured via `signed-api.json` configuration file.
Expand Down
8 changes: 8 additions & 0 deletions packages/pusher/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,8 @@ Enables or disables logging. Options:
- `true` - Enables logging.
- `false` - Disables logging.

Default: `true`.

#### `LOG_FORMAT`

The format of the log output. Options:
Expand All @@ -92,6 +94,8 @@ The format of the log output. Options:
- `pretty` - Logs are formatted in a human-friendly "pretty" way. Ideal, when running the service locally and in
development.

Default: `json`.

#### `LOG_COLORIZE`

Enables or disables colors in the log output. Options:
Expand All @@ -100,6 +104,8 @@ Enables or disables colors in the log output. Options:
Recommended when running locally and in development.
- `false` - Disables colors in the log output. Recommended for production.

Default: `false`.

#### `LOG_LEVEL`

Defines the minimum level of logs. Logs with smaller level (severity) will be silenced. Options:
Expand All @@ -109,6 +115,8 @@ Defines the minimum level of logs. Logs with smaller level (severity) will be si
- `warn` - Enables logs with level `warn` and `error`.
- `error` - Enables logs with level `error`.

Default: `info`.

### Configuration files

Pusher needs two configuration files, `pusher.json` and `secrets.env`. All expressions of a form `${SECRET_NAME}` are
Expand Down