TiDB Audit Plugin User Guide

• 语言: 英语
• 格式: .pdf
• 来源: www.pingcap.com

摘要

文档详细介绍了TiDB审计插件的使用方法，包括下载、部署、配置、事件审计、日志输出和插件状态查看。审计插件记录了TiDB服务器的活动，审计信息存储在日志文件中。文档还提供了如何通过TiDB Operator或TiUP部署插件的步骤，并阐述了如何配置审计事件类型、修改审计配置表以及如何清除审计日志。

AI总结

# TiDB 审计插件用户指南总结

## 1. 配置TiDB插件
- **步骤**：
1. 修改TiDB配置文件，设置插件目录和插件名称：

     plugin.dir: /path/to/plugin
     plugin.load: audit-1

2. 重启所有TiDB节点：

     tiup cluster reload cluster_name -R tidb

- **注意事项**：
- 如果所有节点路径相同，可全局配置。
- 可指定节点进行插件部署。

## 2. 部署插件
- **方法**：
- 使用TiDB Operator或TiUP进行部署。
- 部署时需配置`plugin.load`和`plugin.dir`，并通过`tiup cluster exec`和`tiup cluster push`上传插件文件。

## 3. 修改TABLE_ACCESS配置
- **默认状态**：TABLE_ACCESS事件默认不审计。
- **配置步骤**：
1. 修改`tidb_audit_table_access`表，指定用户名、数据库、表名和事件类型。
2. 执行以下命令更新配置：

     FLUSH TIDB PLUGINS AUDIT;

- **支持的事件类型**：
- Insert, Select, Update, Replace, Delete, LoadData, Alter, DropTable, CreateTable。

## 4. 审计日志输出
- **日志文件**：`tidb-audit.log`，位于TiDB配置目录。
- **事件类型**：
- **CONNECTION**：默认启用，记录连接和认证事件。
- **TABLE_ACCESS**：默认禁用，需配置后启用。
- **GENERAL**：默认启用，记录其他SQL操作。
- **数据处理**：SQL参数中的数据会被 masking 处理。

## 5. 查看插件状态
- 使用命令查看插件状态：

  SHOW PLUGINS;

- 启用或禁用插件：

  -- 启用审计
  ADMIN Plugins enable audit;
  -- 禁用审计
  ADMIN Plugins disable audit;

## 6. 清除审计日志
- 使用命令清除日志：

  tiup cluster clean  --audit-log

- **注意事项**：清除操作不可逆，需先备份数据。

## 7. 总结
- TiDB审计插件提供细粒度的审计功能，支持多种事件类型。
- 配置灵活，可通过修改配置表实现个性化审计需求。
- 注意插件部署、配置和状态管理的细节，确保审计功能正常运行。