Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TiKV config: add 7 log-related congifurations #6372

Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 41 additions & 3 deletions tikv-configuration-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This document only describes the parameters that are not included in command-lin

## Global configuration

### abort-on-panic
### `abort-on-panic`

+ Sets whether to call `abort()` to exit the process when TiKV panics. This option affects whether TiKV allows the system to generate core dump files.

Expand All @@ -23,7 +23,45 @@ This document only describes the parameters that are not included in command-lin

+ Default value: `false`

### server
### `log-level`

+ The log level
+ Available values: "trace", "debug", "info", "warning", "error", "critical"
en-jin19 marked this conversation as resolved.
Show resolved Hide resolved
+ Default value: "info"

### `log-file`

+ The log file. If this parameter is not set, logs are written to "stderr" by default.
en-jin19 marked this conversation as resolved.
Show resolved Hide resolved
+ Default value: ""

### `log-format`

+ The log format
+ Available values: "json", "text"
en-jin19 marked this conversation as resolved.
Show resolved Hide resolved
+ Default value: "text"

### `log-rotation-timespan`

+ The timespan between log rotation. When this timespan passes, log files are rotated, that is, a timestamp is appended to the file name of the current log file, and a new file is created.
en-jin19 marked this conversation as resolved.
Show resolved Hide resolved
+ Default value: "24h"

### `log-rotation-size`

+ The size of a log file that triggers log rotation. Once the size of a log file is bigger than the specified threshold value, log files are rotated. The old log file is placed into the new file, and the new filename is the old filename with a timestamp suffix.
en-jin19 marked this conversation as resolved.
Show resolved Hide resolved
+ Default value: "300MB"

### `slow-log-file`

+ The file to store slow logs
+ If this parameter is not set but `log-file` is set, slow logs are written to the log file that specified in `log-file`. If both `slow-log-file` and `log-file` are not set, all logs are output to "stderr".
en-jin19 marked this conversation as resolved.
Show resolved Hide resolved
+ Default value: ""

### `slow-log-threshold`

+ The threshold to print slow logs. If the process time is longer than this threshold, the slow logs are printed.
en-jin19 marked this conversation as resolved.
Show resolved Hide resolved
+ Default value: "1s"

## server

+ Configuration items related to the server

Expand Down Expand Up @@ -116,7 +154,7 @@ This document only describes the parameters that are not included in command-lin

### `end-point-slow-log-threshold`

+ The time threshold for a TiDB's push down request to print slow log
+ The time threshold for a TiDB's push down request to print slow log. If the process time is longer than this threshold, the slow logs are printed.
en-jin19 marked this conversation as resolved.
Show resolved Hide resolved
+ Default value: `"1s"`
+ Minimum value: `0`

Expand Down