Add logging configuration docs

We should do our best to disambiguate CloudRuntime and loggin parameters
gomods · Apr 20, 2024 · 945d490 · 945d490
1 parent 359c119
commit 945d490
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/docs/content/configuration/logging.md 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.