Logging configuration docs

Co-authored-by: Aleksandr Karbyshev <[email protected]> Co-authored-by: Aleksandr Karbyshev <[email protected]> Co-authored-by: Aleksandr Karbyshev <[email protected]>
anoma · Jul 3, 2023 · b2f7483 · b2f7483
1 parent 6e0b9d1
commit b2f7483
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/packages/docs/pages/experimental/_meta.json b/packages/docs/pages/experimental/_meta.json
@@ -1,4 +1,5 @@
 {
+  "logging-config": "Configuring logging",
   "local-network": "Spinning up a local network",
   "ibc": "IBC"
 }
diff --git a/packages/docs/pages/experimental/logging-config.mdx b/packages/docs/pages/experimental/logging-config.mdx
@@ -0,0 +1,14 @@
+# Configuring Logging on Namada
+
+The logging of the ledger can be configured by setting the following environment variables.
+Default values are in **bold**.
+
+| Variable             | Values                                     | Description             |
+| :------------------: | :----------------------------------------: | :---------------------: |
+| `NAMADA_LOG`         | **`info`**, `debug`, `warn`, `error`       | Logging verbosity       |
+| `NAMADA_LOG_COLOR`   | **`true`**, `false`                        | Switch colors on / off  |
+| `NAMADA_LOG_DIR`     |                                            | If set, the logs will be written to files in the specified directory. The log files will be named `namada.log` and `namada.err.log` and compressed using `gzip`. |
+| `NAMADA_LOG_FMT`     | **`full`**, `json`, `pretty`               | Logging format          |
+| `NAMADA_LOG_ROLLING` | **`never`**, `minutely`, `hourly`, `daily` | Rolling logs frequency  |
+| `NAMADA_CMT_STDOUT`  | `true`, **`false`**                        | Print all the CometBFT logs to stdout. (This information may be valuable to validators.) |
+| `CMT_LOG_LEVEL`      | **`info`**, `debug`, `warn`, `error`       | CometBFT logs verbosity |