Skip to content

clinic: list audit logs as included in diag #21129

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

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
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
12 changes: 12 additions & 0 deletions clinic/clinic-data-instruction-for-tiup.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ This section lists the types of diagnostic data that can be collected by [Diag](
| Log | `tidb.log` | `--include=log` |
| Error log | `tidb_stderr.log` | `--include=log` |
| Slow log | `tidb_slow_query.log` | `--include=log` |
| Audit Logs | `tidb-audit.log.json` | `--include=log` |
| Configuration file | `tidb.toml` | `--include=config` |
| Real-time configuration | `config.json` | `--include=config` |

Expand Down Expand Up @@ -140,3 +141,14 @@ This section lists the types of diagnostic data that can be collected by Diag fr
| Contents in the `/etc/security/limits.conf` system | `limits.conf` | `--include=system` |
| List of kernel parameters | `sysctl.conf` | `--include=system` |
| Socket system information, which is the output of the `ss` command | `ss.txt` | `--include=system` |

### Log file classification

You can use the `--include=log.<type>` parameter to specify which types of logs to collect.

Log types:

- `std`: Log files that contain `stderr` in the filename.
- `rocksdb`: Log files with a `rocksdb` prefix and a `.info` suffix.
- `slow`: Slow query log files.
- `unknown`: Log files that do not match any of the preceding types.