TiDB Audit Plugin User Guide August 4, 2022 TiDB Audit Plugin User Guide Introduction The TiDB audit plugin records the TiDB server’s activities that are expected to follow auditing regulations of of your organization. For each client session, the plugin records users accessing the server (that is, username and IP address), SQL queries executed, databases and tables accessed, environment variable package, and use the audit plugin. Download the plugin You can download the plugin on TiDB Enterprise Edition Downloads. Deploy the audit plugin After downloading the plugin, you can use either TiDB

to speed up the metadata loading when service starts up? . . . . . 354 7.8.28 [Other] The ANTLR plugin generates codes in the same level directory as src, which is easy to commit by mistake. How to avoid bytecode enhance and plug‐in design to provide tracing, metrics and logging features. Enable the plugin in agent to collect data and send data to the integrated 3rd APM system. APM APM is the abbreviation ${CLASS_PATH} ${MAIN_CLASS} >> ${STDOUT_FILE} 2>&1 & • Launch plugin bin/start.sh After normal startup, you can view the startup log of the plugin in the shardingsphere proxy log, and you can view the data

to speed up the metadata loading when service starts up? . . . . . 366 7.8.28 [Other] The ANTLR plugin generates codes in the same level directory as src, which is easy to commit by mistake. How to avoid bytecode enhance and plug‐in design to provide tracing, metrics and logging features. Enable the plugin in agent to collect data and send data to the integrated 3rd APM system. 4.10. Observability 66 ${CLASS_PATH} ${MAIN_CLASS} >> ${STDOUT_FILE} 2>&1 & • Launch plugin bin/start.sh After normal startup, you can view the startup log of the plugin in the shardingsphere proxy log, and you can view the data

• 启动插件 通过改造后的 ShardingSphere‐Proxy 的启动脚本启动。 bin/start.sh 正常启动可以在对应的 ShardingSphere‐Proxy 日志查看到 plugin 的启动日志，访问 Proxy 后，可以通过 配置的地址查看到 Metric 和 Tracing 的数据。 4.10. 可观察性 65 5 用户手册 本章节面向 Apache ShardingSphere Prometheus plugin BaseLoggingPluginDefinitionService Logging plugin JaegerPluginDefinitionService Jaeger plugin OpenTelemetryTracingPluginDefinitionService OpenTelemetryTracing plugin OpenTracing OpenTracingPluginDefinitionService OpenTracing plugin ZipkinPluginDefinitionService Zipkin plugin 6.14. 影子库 220 Apache ShardingSphere document, v5.1.1 6.15.2 PluginBootService SPI 名称 详细说明 PluginBootService

• 启动插件 通过改造后的 ShardingSphere‐Proxy 的启动脚本启动。 bin/start.sh 正常启动可以在对应的 ShardingSphere‐Proxy 日志查看到 plugin 的启动日志，访问 Proxy 后，可以通过 配置的地址查看到 Metric 和 Tracing 的数据。 4.10. 可观察性 64 5 用户手册 本章节面向 Apache ShardingSphere Prometheus plugin BaseLoggingPluginDefinitionService Logging plugin JaegerPluginDefinitionService Jaeger plugin OpenTelemetryTracingPluginDefinitionService OpenTelemetryTracing plugin OpenTracing OpenTracingPluginDefinitionService OpenTracing plugin ZipkinPluginDefinitionService Zipkin plugin 6.14. 影子库 215 Apache ShardingSphere document, v5.1.0 6.15.2 PluginBootService SPI 名称 详细说明 PluginBootService

• 启动插件 通过改造后的 ShardingSphere‐Proxy 的启动脚本启动。 bin/start.sh 正常启动可以在对应的 ShardingSphere‐Proxy 日志查看到 plugin 的启动日志，访问 Proxy 后，可以通过 配置的地址查看到 Metric 和 Tracing 的数据。 4.10. 可观察性 66 5 用户手册 本章节面向 Apache ShardingSphere Prometheus plugin BaseLoggingPluginDefinitionService Logging plugin JaegerPluginDefinitionService Jaeger plugin OpenTelemetryTracingPluginDefinitionService OpenTelemetryTracing plugin OpenTracing OpenTracing plugin ZipkinPluginDefinitionService Zipkin plugin 6.15.2 PluginBootService SPI 名称 详细说明 PluginBootService 插件启动服务定义 已知实现类 详细说明 PrometheusPluginBootService Prometheus plugin 启动类 BaseLo

XA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301 7.24 The ANTLR plugin generates codes in the same level directory as src, which is easy to commit by mistake. How to avoid an independent and independently designed project based on ByteBuddy bytecode increase. Based on plugin design, it can integrate seamlessly with ShardingSphere. There are currently Log, metrics, APM and python3 plot_graph.py sharding_ms python3 plot_graph.py encrypt b. Use Jenkins "Publish HTML reports" plugin to integrate all images into one HTML page 3.10. Test Engine 117 Apache ShardingSphere document

to speed up the metadata loading when service starts up? . . . 311 7.7.25 25. [Other] The ANTLR plugin generates codes in the same level directory as src, which is easy to commit by mistake. How to avoid an independent and independently designed project based on ByteBuddy bytecode increase. Based on plugin design, it can integrate seamlessly with ShardingSphere. There are currently Log, metrics, APM and show variable cac hed_connections show variable agen t_plugins_enabled Query whether the agent plugin are enabled show variable agent_ plugins_enabled preview SQL Preview the actual SQLs preview select

spring.shardingsphere.orchestration.name= # 治理实例名称 spring.shardingsphere.orchestration.overwrite= # 本地配置是否覆盖注册中心配置。如果可覆盖， 每次启动都以本地配置为准 spring.shardingsphere.orchestration.registry.type= # 配置中心类型。如：zookeeper 配置中心类型。如：zookeeper spring.shardingsphere.orchestration.registry.server-lists= # 连接注册中心服务器的列表。 包括 IP 地址和端口号。多个地址用逗号分隔。如: host1:2181,host2:2181 spring.shardingsphere.orchestration.registry.namespace= # 注册中心的命名空间 注册中心的命名空间 spring.shardingsphere.orchestration.registry.digest= # 连接注册中心的权限令牌。缺省为不需 要权限验证 spring.shardingsphere.orchestration.registry.operation-timeout-milliseconds= # 操作 超时的毫秒数，默认 500 毫秒 spring.shardingsphere

-> (name in config) plugin-notifications notifications { core: { [core package name]: { [property name]: [property value] }, ... }, plugin: { [plugin package name]: { childrenLimit: 500, editing: true, deleting: true } }, plugin: { 'sql-editor': { maxFileSize: 100 }, notifications: { { ... 'plugin.log-viewer.refreshTimeout': 3000, 'plugin.log-viewer.maxLogRecords': 1000, 'plugin.log-viewer.logBatchSize': 2000, 'plugin.log-viewer.maxFailedRequests': 3, 'plugin.data-export