Skip to content

Commit

Permalink
Add logging configuration docs (#1952)
Browse files Browse the repository at this point in the history
We should do our best to disambiguate CloudRuntime and logging parameters.
  • Loading branch information
matt0x6F committed Apr 21, 2024
1 parent ae36734 commit 78daa57
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions 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.

0 comments on commit 78daa57

Please sign in to comment.