Document logger defaults (#126)

api3dao · Nov 21, 2023 · 897794f · 897794f
1 parent 7aea018
commit 897794f
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git 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
@@ -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