chore: short desc markdown about change log level (GreptimeTeam#4921)

* chore: tiny doc about change log level * chore: per review * chore
lyang24 · Nov 1, 2024 · 1ff29d8 · 1ff29d8
1 parent 39ab1a6
commit 1ff29d8
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/docs/how-to/how-to-change-log-level-on-the-fly.md b/docs/how-to/how-to-change-log-level-on-the-fly.md
@@ -0,0 +1,16 @@
+# Change Log Level on the Fly
+
+## HTTP API
+
+example:
+```bash
+curl --data "trace;flow=debug" 127.0.0.1:4000/debug/log_level
+```
+And database will reply with something like:
+```bash
+Log Level changed from Some("info") to "trace;flow=debug"%
+```
+
+The data is a string in the format of `global_level;module1=level1;module2=level2;...` that follow the same rule of `RUST_LOG`. 
+
+The module is the module name of the log, and the level is the log level. The log level can be one of the following: `trace`, `debug`, `info`, `warn`, `error`, `off`(case insensitive).