From 78daa574e9dc29c25cd75221bba6ce684d6174f4 Mon Sep 17 00:00:00 2001 From: Matt Date: Sun, 21 Apr 2024 11:29:42 -0700 Subject: [PATCH] Add logging configuration docs (#1952) We should do our best to disambiguate CloudRuntime and logging parameters. --- docs/content/configuration/logging.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 docs/content/configuration/logging.md diff --git a/docs/content/configuration/logging.md b/docs/content/configuration/logging.md new file mode 100644 index 000000000..bd85d00b1 --- /dev/null +++ b/docs/content/configuration/logging.md @@ -0,0 +1,15 @@ +--- +title: Logging +description: Configure the logger for your desired output +weight: 9 +--- + +Athens is designed to support a myriad of logging scenarios. + +## Standard + +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. + +## 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