Skip to content

Commit

Permalink
Document log level format (#1982)
Browse files Browse the repository at this point in the history
Specify log levels that can be configured with Athens explicitly in the documentation.
  • Loading branch information
raxod502-plaid authored Sep 30, 2024
1 parent 0092d3a commit 74b3cf5
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/content/configuration/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ Athens is designed to support a myriad of logging scenarios.

The standard structured logger can be configured in `plain` or `json` formatting via `LogFormat` or `ATHENS_LOG_FORMAT`. Additionally, verbosity can be controlled by setting `LogLevel` or `ATHENS_LOG_LEVEL`. In order for the standard structured logger to work, `CloudRuntime` and `ATHENS_CLOUD_RUNTIME` should not be set to a valid value.

The logging is via [Logrus](https://github.com/sirupsen/logrus), so the allowed values for logging config options are determined by that project. For example, `ATHENS_LOG_LEVEL` can be `debug`, `info`, `warn`/`warning`, `error`, etc.

## Runtimes

Athens can be configured according to certain cloud provider specific runtimes. The **GCP** runtime configures Athens to rename certain logging fields that could be dropped or overriden when running in a GCP logging environment. This runtime can be used with `LogLevel` or `ATHENS_LOG_LEVEL` to control the verbosity of logs.
Athens can be configured according to certain cloud provider specific runtimes. The **GCP** runtime configures Athens to rename certain logging fields that could be dropped or overriden when running in a GCP logging environment. This runtime can be used with `LogLevel` or `ATHENS_LOG_LEVEL` to control the verbosity of logs.

0 comments on commit 74b3cf5

Please sign in to comment.