Skip to content

Commit

Permalink
Document LOG_LEVEL and LOG_COLORS config options
Browse files Browse the repository at this point in the history
  • Loading branch information
alco committed Nov 28, 2024
1 parent f197e1a commit 62d34db
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions website/docs/api/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -297,3 +297,35 @@ Expose a prometheus reporter for telemetry data on the specified port.
Enable sending telemetry data to a StatsD reporting endpoint.

</EnvVarConfig>

## Logging

### ELECTRIC_LOG_LEVEL

<EnvVarConfig
name="ELECTRIC_LOG_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_LOG_COLORS

<EnvVarConfig
name="ELECTRIC_LOG_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>

0 comments on commit 62d34db

Please sign in to comment.