Skip to content

Commit

Permalink
Document logging-related config options
Browse files Browse the repository at this point in the history
  • Loading branch information
alco committed Nov 29, 2024
1 parent dc422ee commit 9aefc80
Showing 1 changed file with 43 additions and 11 deletions.
54 changes: 43 additions & 11 deletions website/docs/api/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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>

0 comments on commit 9aefc80

Please sign in to comment.