From 9aefc80ffca5949e60c4011ec8bee116b0fb90b4 Mon Sep 17 00:00:00 2001
From: Oleksii Sholik <oleksii@sholik.dev>
Date: Thu, 28 Nov 2024 15:00:19 +0200
Subject: [PATCH] Document logging-related config options

---
 website/docs/api/config.md | 54 ++++++++++++++++++++++++++++++--------
 1 file changed, 43 insertions(+), 11 deletions(-)

diff --git a/website/docs/api/config.md b/website/docs/api/config.md
index 79dd7c44ca..ec2c75f055 100644
--- a/website/docs/api/config.md
+++ b/website/docs/api/config.md
@@ -147,17 +147,6 @@ See [#1581](https://github.com/electric-sql/electric/issues/1581) for context.
 
 </EnvVarConfig>
 
-### ELECTRIC_LOG_OTP_REPORTS
-
-<EnvVarConfig
-    name="ELECTRIC_LOG_OTP_REPORTS"
-    defaultValue="false"
-    example="true">
-
-Enable [OTP SASL](https://www.erlang.org/doc/apps/sasl/sasl_app.html) reporting at runtime.
-
-</EnvVarConfig>
-
 ### ELECTRIC_PORT
 
 <EnvVarConfig
@@ -299,3 +288,46 @@ Expose a prometheus reporter for telemetry data on the specified port.
 Enable sending telemetry data to a StatsD reporting endpoint.
 
 </EnvVarConfig>
+
+## Logging
+
+### ELECTRIC_LOGGING_LEVEL
+
+<EnvVarConfig
+    name="ELECTRIC_LOGGING_LEVEL"
+    optional="true"
+    example="debug">
+
+Verbosity of Electric's log output.
+
+Available levels, in the order of increasing verbosity:
+- `error`
+- `warning`
+- `info`
+- `debug`
+
+</EnvVarConfig>
+
+### ELECTRIC_LOGGING_COLORS
+
+<EnvVarConfig
+    name="ELECTRIC_LOGGING_COLORS"
+    optional="true"
+    example="false">
+
+Enable or disable ANSI coloring of Electric's log output.
+
+By default, coloring is enabled when Electric's stdout is connected to a terminal. This may be undesirable in certain runtime environments, such as AWS which displays ANSI color codes using escape sequences and may incorrectly split log entries into multiple lines.
+
+</EnvVarConfig>
+
+### ELECTRIC_LOGGING_OTP_REPORTS
+
+<EnvVarConfig
+    name="ELECTRIC_LOGGING_OTP_REPORTS"
+    defaultValue="false"
+    example="true">
+
+Enable [OTP SASL](https://www.erlang.org/doc/apps/sasl/sasl_app.html) reporting at runtime.
+
+</EnvVarConfig>