From 897794fa65a9f6a5152f2fdca9f17a8680901d28 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Emanuel=20Tesa=C5=99?= Date: Tue, 21 Nov 2023 13:11:19 +0100 Subject: [PATCH] Document logger defaults (#126) --- packages/api/README.md | 8 ++++++++ packages/pusher/README.md | 8 ++++++++ 2 files changed, 16 insertions(+) diff --git a/packages/api/README.md b/packages/api/README.md index 3c26d9c6..49be0e2b 100644 --- a/packages/api/README.md +++ b/packages/api/README.md @@ -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: @@ -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: @@ -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: @@ -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. diff --git a/packages/pusher/README.md b/packages/pusher/README.md index 38dd71cf..91b221b9 100644 --- a/packages/pusher/README.md +++ b/packages/pusher/README.md @@ -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: @@ -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: @@ -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: @@ -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