primal/athens
1
0
Fork 0
mirror of https://github.com/gomods/athens synced 2026-02-03 08:40:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add logging configuration docs (#1952)

Browse Source 
We should do our best to disambiguate CloudRuntime and logging parameters.
This commit is contained in:
Matt
2024-04-21 11:29:42 -07:00
committed by GitHub
parent ae36734542
commit 78daa574e9
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/content/configuration/logging.md
+15
View File
@@ -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.