diff options
| author | DanConwayDev <DanConwayDev@protonmail.com> | 2026-02-23 15:20:59 +0000 |
|---|---|---|
| committer | DanConwayDev <DanConwayDev@protonmail.com> | 2026-02-23 15:20:59 +0000 |
| commit | 113928aa84894ea8f65c247d9987527e792b32a9 (patch) | |
| tree | ec967d6195d9f7ec4f061449596611afe3a0950f /docs/reference/configuration.md | |
| parent | 26f608e5011b9d1ad6036da75b89272835e69695 (diff) | |
| parent | e0ad39a489b3398f8208713bf728db0cb11475b0 (diff) | |
Merge master into 3ca0-announcements-purgatory
Diffstat (limited to 'docs/reference/configuration.md')
| -rw-r--r-- | docs/reference/configuration.md | 37 |
1 files changed, 25 insertions, 12 deletions
diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md index b24b498..b09b20f 100644 --- a/docs/reference/configuration.md +++ b/docs/reference/configuration.md | |||
| @@ -1041,10 +1041,10 @@ Per-connection limits (built-in to relay-builder, not configurable): | |||
| 1041 | 1041 | ||
| 1042 | ### Logging Configuration | 1042 | ### Logging Configuration |
| 1043 | 1043 | ||
| 1044 | #### `RUST_LOG` | 1044 | #### `NGIT_LOG_LEVEL` |
| 1045 | 1045 | ||
| 1046 | **Description:** Logging level and filters (standard Rust environment variable) | 1046 | **Description:** Logging level and filters for application logging |
| 1047 | **Type:** String (log level or filter) | 1047 | **Type:** String (log level or filter expression) |
| 1048 | **Default:** `info` | 1048 | **Default:** `info` |
| 1049 | **Required:** No | 1049 | **Required:** No |
| 1050 | 1050 | ||
| @@ -1052,17 +1052,17 @@ Per-connection limits (built-in to relay-builder, not configurable): | |||
| 1052 | 1052 | ||
| 1053 | ```bash | 1053 | ```bash |
| 1054 | # Simple levels | 1054 | # Simple levels |
| 1055 | RUST_LOG=error # Errors only | 1055 | NGIT_LOG_LEVEL=error # Errors only |
| 1056 | RUST_LOG=warn # Warnings and errors | 1056 | NGIT_LOG_LEVEL=warn # Warnings and errors |
| 1057 | RUST_LOG=info # Info, warnings, errors | 1057 | NGIT_LOG_LEVEL=info # Info, warnings, errors (default) |
| 1058 | RUST_LOG=debug # Debug and above | 1058 | NGIT_LOG_LEVEL=debug # Debug and above |
| 1059 | RUST_LOG=trace # Everything | 1059 | NGIT_LOG_LEVEL=trace # Everything (very verbose) |
| 1060 | 1060 | ||
| 1061 | # Module-specific | 1061 | # Module-specific filtering |
| 1062 | RUST_LOG=ngit_grasp=debug,actix_web=info | 1062 | NGIT_LOG_LEVEL=ngit_grasp=debug,actix_web=info |
| 1063 | 1063 | ||
| 1064 | # Complex filters | 1064 | # Complex filters |
| 1065 | RUST_LOG=debug,hyper=info,tokio=warn | 1065 | NGIT_LOG_LEVEL=debug,hyper=info,tokio=warn |
| 1066 | ``` | 1066 | ``` |
| 1067 | 1067 | ||
| 1068 | **Log levels (most to least verbose):** | 1068 | **Log levels (most to least verbose):** |
| @@ -1073,12 +1073,25 @@ RUST_LOG=debug,hyper=info,tokio=warn | |||
| 1073 | 4. `warn` - Warnings about potential issues | 1073 | 4. `warn` - Warnings about potential issues |
| 1074 | 5. `error` - Errors only | 1074 | 5. `error` - Errors only |
| 1075 | 1075 | ||
| 1076 | **CLI flag:** | ||
| 1077 | |||
| 1078 | ```bash | ||
| 1079 | ngit-grasp --log-level trace | ||
| 1080 | ``` | ||
| 1081 | |||
| 1076 | **Production recommendation:** | 1082 | **Production recommendation:** |
| 1077 | 1083 | ||
| 1078 | ```bash | 1084 | ```bash |
| 1079 | RUST_LOG=info,ngit_grasp=debug | 1085 | NGIT_LOG_LEVEL=info |
| 1080 | ``` | 1086 | ``` |
| 1081 | 1087 | ||
| 1088 | **Notes:** | ||
| 1089 | |||
| 1090 | - Uses Rust's `tracing` crate filter syntax | ||
| 1091 | - Supports module-level filtering (e.g., `ngit_grasp=debug,hyper=info`) | ||
| 1092 | - `trace` level can significantly impact performance | ||
| 1093 | - For production, `info` or `warn` is recommended | ||
| 1094 | |||
| 1082 | --- | 1095 | --- |
| 1083 | 1096 | ||
| 1084 | ### Security Configuration (Planned) | 1097 | ### Security Configuration (Planned) |