Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add logging configuration docs #1952

Merged
merged 2 commits into from
Apr 21, 2024
Merged

Add logging configuration docs #1952

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
945d490
Add logging configuration docs
matt0x6F Apr 20, 2024
fec3c60
Merge branch 'main' into add-logging-docs
matt0x6F Apr 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/content/configuration/logging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.