From c000abf821adaee0373a0d0e63546aa344cc04cb Mon Sep 17 00:00:00 2001 From: Radon Rosborough Date: Tue, 3 Sep 2024 09:52:48 -0700 Subject: [PATCH] Document log level format --- docs/content/configuration/logging.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/content/configuration/logging.md b/docs/content/configuration/logging.md index bd85d00b1..1bda06606 100644 --- a/docs/content/configuration/logging.md +++ b/docs/content/configuration/logging.md @@ -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. \ No newline at end of file +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.