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) #6467

Merged
Merged
Changes from all commits
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: 42 additions & 2 deletions tikv-configuration-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,47 @@ The TiKV configuration file supports more options than command-line parameters.

This document only describes the parameters that are not included in command-line parameters. For more details, see [command-line parameter](/command-line-flags-for-tikv-configuration.md).

### server
## Global configuration

### `log-level`

+ The log level
+ Value options: "trace", "debug", "info", "warning", "error", "critical"
+ Default value: "info"

### `log-file`

+ The log file. If this configuration is not set, logs are output to "stderr" by default.
+ Default value: ""

### `log-format`

+ The log format
+ Value options: "json", "text"
+ Default value: "text"

### `log-rotation-timespan`

+ The timespan between log rotations. 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.
+ 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 file name is the old file name with a timestamp suffix.
+ Default value: "300MB"

### `slow-log-file`

+ The file to store slow logs
+ If this configuration is not set but `log-file` is set, slow logs are output to the log file specified by `log-file`. If neither `slow-log-file` nor `log-file` are set, all logs are output to "stderr".
+ Default value: ""

### `slow-log-threshold`

+ The threshold for outputing slow logs. If the processing time is longer than this threshold, slow logs are output.
+ Default value: "1s"

## server

+ Configuration items related to the server

Expand Down Expand Up @@ -104,7 +144,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 output slow log. If the processing time is longer than this threshold, the slow logs are output.
+ Default value: `"1s"`
+ Minimum value: `0`

Expand Down