Skip to content

Commit 4036db7

Browse files
authored
docs: add some docs (#14)
1 parent a14373c commit 4036db7

File tree

6 files changed

+387
-8
lines changed

6 files changed

+387
-8
lines changed

docs/global-options.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Global Options (System properties / Java -Dxxx)
2+
3+
| Name | Description |
4+
|:-----------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------|
5+
| greptimedb.use_os_signal | Whether or not to use OS Signal, SDK listens for SIGUSR2 signals by default and can outputs some information. This is helpful when troubleshooting complex issues. |
6+
| greptimedb.signal.out_dir | Signal handler can output to the specified directory, default is the process start directory. |
7+
| greptimedb.available_cpus | Specify the number of available cpus, the default is to use the full number of cpus of the current environment. |
8+
| greptimedb.reporter.period_minutes | Metrics reporter timed output period, default 30 minutes. |
9+
| greptimedb.read.write.rw_logging | Whether to print logs for each read/write operation, default off. |

docs/magic-tools.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Magic Tools
2+
3+
### How to use `kill -s SIGUSR2 $pid`
4+
5+
The first time you execute `kill -s SIGUSR2 $pid` you will see the following help messages on
6+
the log output, including:
7+
8+
- Turn on/off the output of the condensed version of the read/write log.
9+
- Turn on/off limiter
10+
- Export in-memory metrics and memory state information of important objects to a local file
11+
12+
### Just follow the help information
13+
14+
```text
15+
- -- GreptimeDB Signal Help --
16+
- Signal output dir: /Users/xxx
17+
-
18+
- How to open or close read/write log(The second execution means close):
19+
- [1] `cd /Users/xxx`
20+
- [2] `touch rw_logging.sig`
21+
- [3] `kill -s SIGUSR2 $pid`
22+
- [4] `rm rw_logging.sig`
23+
-
24+
-
25+
- How to open or close rpc limiter(The second execution means close):
26+
- [1] `cd /Users/xxx`
27+
- [2] `touch rpc_limit.sig`
28+
- [3] `kill -s SIGUSR2 $pid`
29+
- [4] `rm rpc_limit.sig`
30+
-
31+
- How to get metrics and display info:
32+
- [1] `cd /Users/xxx`
33+
- [2] `rm *.sig`
34+
- [3] `kill -s SIGUSR2 $pid`
35+
-
36+
- The file signals that is currently open:
37+
-
38+
- Displaying GreptimeDB clients triggered by signal: USR2 to file: /Users/xxx/greptimedb_client_display.log.2024-01-09_16-28-38.
39+
- Printing GreptimeDB client metrics triggered by signal: USR2 to file: /Users/xxx/greptimedb_client_metrics.log.2024-01-09_16-28-38.
40+
```

0 commit comments

Comments
 (0)