docs: update docs

Author: soulteary

README-zhCN.md

@@ -10,10 +10,10 @@
 ## ✨ 核心特性
 
 - 🔒 **安全优先**：命令路径白名单、参数验证、严格模式和安全日志记录
-- ⚡ **高性能**：可配置并发、速率限制和优化的请求处理
+- ⚡ **高性能**：可配置并发、速率限制（含基于 Redis 的分布式限流）与优化的请求处理
 - 🎯 **灵活配置**：支持 JSON 和 YAML 配置文件，支持 Go 模板
 - 🔐 **高级认证**：多种触发规则类型，包括 HMAC 签名验证、IP 白名单和自定义规则
-- 📊 **可观测性**：内置 Prometheus 指标、健康检查端点和全面的日志记录
+- 📊 **可观测性**：内置 Prometheus 指标、健康检查端点、OpenTelemetry 追踪、审计日志与全面日志
 - 🐳 **容器就绪**：官方 Docker 镜像，提供多个变体
 - 🌍 **国际化**：完整的中英文文档支持
 - 🔄 **热重载**：无需重启服务器即可更新钩子配置

README.md

@@ -10,10 +10,10 @@
 ## ✨ Key Features
 
 - 🔒 **Security First**: Command path whitelisting, argument validation, strict mode, and secure logging
-- ⚡ **High Performance**: Configurable concurrency, rate limiting, and optimized request handling
+- ⚡ **High Performance**: Configurable concurrency, rate limiting (including Redis-backed distributed), and optimized request handling
 - 🎯 **Flexible Configuration**: Support for JSON and YAML configuration files with Go template support
 - 🔐 **Advanced Authentication**: Multiple trigger rule types including HMAC signature validation, IP whitelisting, and custom rules
-- 📊 **Observability**: Built-in Prometheus metrics, health check endpoint, and comprehensive logging
+- 📊 **Observability**: Built-in Prometheus metrics, health check endpoint, OpenTelemetry tracing, audit logging, and comprehensive logging
 - 🐳 **Container Ready**: Official Docker images with multiple variants
 - 🌍 **Internationalization**: Full support for English and Chinese documentation
 - 🔄 **Hot Reload**: Update hook configurations without restarting the server
@@ -146,7 +146,7 @@ For more security options, see:
 
 ## Additional Features
 
-- **Form Data Support**: Parse multipart form data and file uploads - see [Form Data](docs/en-US/Form-Data.md)
+- **Form Data Support**: Parse multipart form data and file uploads - see [Form Data](docs/en-US/Referencing-Request-Values.md)
 - **Template Support**: Use Go templates in configuration files with `-template` flag - see [Templates](docs/en-US/Templates.md)
 - **HTTPS**: Use a reverse proxy (nginx, Traefik, Caddy) for HTTPS support
 - **CORS**: Set custom headers including CORS headers with `-header name=value`

docs/en-US/Migration-Guide.md

@@ -370,6 +370,16 @@ docker run -d \
    - Health check endpoint
    - System metrics
 
+### Observability and Compliance
+
+This fork also supports:
+
+- **Distributed tracing (OpenTelemetry/OTLP):** Export traces to any OTLP-compatible backend. Use `-tracing-enabled`, `-otlp-endpoint`, and `-tracing-service-name`.
+- **Audit logging:** Record hook executions and requests to file, Redis, or database. Use `-audit-enabled`, `-audit-storage-type`, `-audit-file-path`, and related options.
+- **Redis-based distributed rate limiting:** Share rate-limit state across multiple webhook instances. Use `-redis-enabled`, `-redis-addr`, `-rate-limit-window`, and related options.
+
+For full parameter lists and environment variables, see [Webhook Parameters](Webhook-Parameters.md).
+
 ---
 
 ## Migration Checklist

docs/en-US/Webhook-Parameters.md

@@ -40,6 +40,8 @@ This document describes all available command-line parameters and environment va
 | `-x-request-id` | Use X-Request-Id header, if present, as request ID | `false` |
 | `-x-request-id-limit int` | Truncate X-Request-Id header to limit | `0` (no limit) |
 
+*Note:* The length limit is configurable only via the `-x-request-id-limit` flag; no separate environment variable is defined in the current implementation.
+
 ### Response Headers
 
 | Flag | Description | Default |
@@ -78,6 +80,17 @@ This document describes all available command-line parameters and environment va
 | `-rate-limit-rps int` | Rate limit requests per second | `100` |
 | `-rate-limit-burst int` | Rate limit burst size | `10` |
 
+### Redis Rate Limiting
+
+| Flag | Description | Default |
+|------|-------------|---------|
+| `-redis-enabled` | Enable Redis for distributed rate limiting | `false` |
+| `-redis-addr string` | Redis server address | `localhost:6379` |
+| `-redis-password string` | Redis password | (empty) |
+| `-redis-db int` | Redis database index | `0` |
+| `-redis-key-prefix string` | Redis key prefix for rate limiting | `webhook:ratelimit:` |
+| `-rate-limit-window int` | Rate limit window in seconds | `60` |
+
 ### HTTP Server Timeouts
 
 | Flag | Description | Default |
@@ -98,6 +111,25 @@ This document describes all available command-line parameters and environment va
 | `-max-args-count int` | Maximum number of command arguments | `1000` |
 | `-strict-mode` | Reject arguments containing potentially dangerous characters | `false` |
 
+### Tracing
+
+| Flag | Description | Default |
+|------|-------------|---------|
+| `-tracing-enabled` | Enable distributed tracing with OpenTelemetry | `false` |
+| `-otlp-endpoint string` | OTLP exporter endpoint (e.g., localhost:4318) | (empty) |
+| `-tracing-service-name string` | Service name for tracing | `webhook` |
+
+### Audit
+
+| Flag | Description | Default |
+|------|-------------|---------|
+| `-audit-enabled` | Enable audit logging | `false` |
+| `-audit-storage-type string` | Audit storage type: file, redis, or database | `file` |
+| `-audit-file-path string` | Audit log file path when storage type is file | `./audit.log` |
+| `-audit-queue-size int` | Audit async write queue size | `1000` |
+| `-audit-workers int` | Number of audit async write workers | `2` |
+| `-audit-mask-ip` | Mask IP addresses in audit logs | `true` |
+
 ### Other
 
 | Flag | Description | Default |
@@ -138,9 +170,10 @@ All command-line parameters can also be set via environment variables:
 | `MAX_MPART_MEM` | `-max-multipart-mem` | Max multipart memory | `1048576` |
 | `MAX_REQUEST_BODY_SIZE` | `-max-request-body-size` | Max request body size | `10485760` |
 | `X_REQUEST_ID` | `-x-request-id` | Use X-Request-Id | `false` |
-| `X_REQUEST_ID_LIMIT` | `-x-request-id-limit` | X-Request-Id limit | `0` |
 | `HEADER` | `-header` | Response header | - |
 
+*Note:* The X-Request-Id length limit is only configurable via the `-x-request-id-limit` flag; there is no dedicated environment variable.
+
 ### Process Management
 
 | Environment Variable | CLI Flag | Description | Default |
@@ -173,6 +206,17 @@ All command-line parameters can also be set via environment variables:
 | `RATE_LIMIT_RPS` | `-rate-limit-rps` | Requests per second | `100` |
 | `RATE_LIMIT_BURST` | `-rate-limit-burst` | Burst size | `10` |
 
+### Redis Rate Limiting
+
+| Environment Variable | CLI Flag | Description | Default |
+|---------------------|----------|-------------|---------|
+| `REDIS_ENABLED` | `-redis-enabled` | Enable Redis for distributed rate limiting | `false` |
+| `REDIS_ADDR` | `-redis-addr` | Redis server address | `localhost:6379` |
+| `REDIS_PASSWORD` | `-redis-password` | Redis password | (empty) |
+| `REDIS_DB` | `-redis-db` | Redis database index | `0` |
+| `REDIS_KEY_PREFIX` | `-redis-key-prefix` | Redis key prefix for rate limiting | `webhook:ratelimit:` |
+| `RATE_LIMIT_WINDOW` | `-rate-limit-window` | Rate limit window (seconds) | `60` |
+
 ### HTTP Server Timeouts
 
 | Environment Variable | CLI Flag | Description | Default |
@@ -193,6 +237,25 @@ All command-line parameters can also be set via environment variables:
 | `MAX_ARGS_COUNT` | `-max-args-count` | Max argument count | `1000` |
 | `STRICT_MODE` | `-strict-mode` | Strict mode | `false` |
 
+### Tracing
+
+| Environment Variable | CLI Flag | Description | Default |
+|---------------------|----------|-------------|---------|
+| `TRACING_ENABLED` | `-tracing-enabled` | Enable distributed tracing | `false` |
+| `OTLP_ENDPOINT` | `-otlp-endpoint` | OTLP exporter endpoint | (empty) |
+| `TRACING_SERVICE_NAME` | `-tracing-service-name` | Tracing service name | `webhook` |
+
+### Audit
+
+| Environment Variable | CLI Flag | Description | Default |
+|---------------------|----------|-------------|---------|
+| `AUDIT_ENABLED` | `-audit-enabled` | Enable audit logging | `false` |
+| `AUDIT_STORAGE_TYPE` | `-audit-storage-type` | Audit storage type (file/redis/database) | `file` |
+| `AUDIT_FILE_PATH` | `-audit-file-path` | Audit log file path | `./audit.log` |
+| `AUDIT_QUEUE_SIZE` | `-audit-queue-size` | Audit async queue size | `1000` |
+| `AUDIT_WORKERS` | `-audit-workers` | Audit async workers | `2` |
+| `AUDIT_MASK_IP` | `-audit-mask-ip` | Mask IP in audit logs | `true` |
+
 ## Security Best Practices
 
 ### Command Path Whitelisting

docs/zh-CN/CLI-ENV.md

@@ -68,6 +68,8 @@
 - `-x-request-id-limit int`
   截断 `X-Request-Id` 请求头的长度限制；默认无限制
 
+  **说明**：长度限制当前仅能通过 `-x-request-id-limit` 配置；当前实现未提供单独的环境变量。
+
 ### 响应头
 
 - `-header value`
@@ -127,6 +129,28 @@
 - `-rate-limit-burst int`
   设置突发请求的最大数量（默认值：`10`）
 
+### Redis 分布式限流
+
+以下参数用于配置基于 Redis 的分布式限流，适用于多实例部署：
+
+- `-redis-enabled`
+  启用 Redis 分布式限流（默认值：`false`）
+
+- `-redis-addr string`
+  Redis 服务器地址（默认值：`localhost:6379`）
+
+- `-redis-password string`
+  Redis 密码（默认值：空）
+
+- `-redis-db int`
+  Redis 数据库索引（默认值：`0`）
+
+- `-redis-key-prefix string`
+  限流键前缀（默认值：`webhook:ratelimit:`）
+
+- `-rate-limit-window int`
+  限流时间窗口（秒，默认值：`60`）
+
 ### HTTP 服务器超时配置
 
 以下参数用于配置 HTTP 服务器的各种超时时间：
@@ -184,6 +208,41 @@
 
   在严格模式下，包含 shell 特殊字符（如 `;`, `|`, `&`, `` ` ``, `$`, `()`, `{}` 等）的参数将被拒绝执行。
 
+### 分布式追踪
+
+以下参数用于配置 OpenTelemetry 分布式追踪：
+
+- `-tracing-enabled`
+  启用分布式追踪（默认值：`false`）
+
+- `-otlp-endpoint string`
+  OTLP 导出端点（例如 `localhost:4318`，默认值：空）
+
+- `-tracing-service-name string`
+  追踪服务名称（默认值：`webhook`）
+
+### 审计日志
+
+以下参数用于配置审计日志：
+
+- `-audit-enabled`
+  启用审计日志（默认值：`false`）
+
+- `-audit-storage-type string`
+  审计存储类型：file、redis 或 database（默认值：`file`）
+
+- `-audit-file-path string`
+  审计日志文件路径（当存储类型为 file 时，默认值：`./audit.log`）
+
+- `-audit-queue-size int`
+  异步写入队列大小（默认值：`1000`）
+
+- `-audit-workers int`
+  异步写入工作协程数（默认值：`2`）
+
+- `-audit-mask-ip`
+  在审计日志中脱敏 IP 地址（默认值：`true`）
+
 ### 其他
 
 - `-version`
@@ -227,9 +286,10 @@
 | `MAX_MPART_MEM` | `-max-multipart-mem` | 最大 multipart 内存 | `1048576` |
 | `MAX_REQUEST_BODY_SIZE` | `-max-request-body-size` | 最大请求体大小 | `10485760` |
 | `X_REQUEST_ID` | `-x-request-id` | 使用 X-Request-Id | `false` |
-| `X_REQUEST_ID_LIMIT` | `-x-request-id-limit` | X-Request-Id 长度限制 | `0` |
 | `HEADER` | `-header` | 响应头（格式：`name=value`） | - |
 
+**说明**：X-Request-Id 长度限制仅能通过 `-x-request-id-limit` 配置，无对应环境变量。
+
 ### 进程管理
 
 | 环境变量 | 命令行参数 | 说明 | 默认值 |
@@ -262,6 +322,17 @@
 | `RATE_LIMIT_RPS` | `-rate-limit-rps` | 每秒请求数限制 | `100` |
 | `RATE_LIMIT_BURST` | `-rate-limit-burst` | 突发请求数限制 | `10` |
 
+### Redis 分布式限流
+
+| 环境变量 | 命令行参数 | 说明 | 默认值 |
+|---------|-----------|------|--------|
+| `REDIS_ENABLED` | `-redis-enabled` | 启用 Redis 分布式限流 | `false` |
+| `REDIS_ADDR` | `-redis-addr` | Redis 服务器地址 | `localhost:6379` |
+| `REDIS_PASSWORD` | `-redis-password` | Redis 密码 | （空） |
+| `REDIS_DB` | `-redis-db` | Redis 数据库索引 | `0` |
+| `REDIS_KEY_PREFIX` | `-redis-key-prefix` | 限流键前缀 | `webhook:ratelimit:` |
+| `RATE_LIMIT_WINDOW` | `-rate-limit-window` | 限流时间窗口（秒） | `60` |
+
 ### HTTP 服务器超时配置
 
 | 环境变量 | 命令行参数 | 说明 | 默认值 |
@@ -282,6 +353,25 @@
 | `MAX_ARGS_COUNT` | `-max-args-count` | 最大参数数量 | `1000` |
 | `STRICT_MODE` | `-strict-mode` | 严格模式 | `false` |
 
+### 分布式追踪
+
+| 环境变量 | 命令行参数 | 说明 | 默认值 |
+|---------|-----------|------|--------|
+| `TRACING_ENABLED` | `-tracing-enabled` | 启用分布式追踪 | `false` |
+| `OTLP_ENDPOINT` | `-otlp-endpoint` | OTLP 导出端点 | （空） |
+| `TRACING_SERVICE_NAME` | `-tracing-service-name` | 追踪服务名称 | `webhook` |
+
+### 审计日志
+
+| 环境变量 | 命令行参数 | 说明 | 默认值 |
+|---------|-----------|------|--------|
+| `AUDIT_ENABLED` | `-audit-enabled` | 启用审计日志 | `false` |
+| `AUDIT_STORAGE_TYPE` | `-audit-storage-type` | 审计存储类型（file/redis/database） | `file` |
+| `AUDIT_FILE_PATH` | `-audit-file-path` | 审计日志文件路径 | `./audit.log` |
+| `AUDIT_QUEUE_SIZE` | `-audit-queue-size` | 异步写入队列大小 | `1000` |
+| `AUDIT_WORKERS` | `-audit-workers` | 异步写入工作协程数 | `2` |
+| `AUDIT_MASK_IP` | `-audit-mask-ip` | 审计日志中脱敏 IP | `true` |
+
 ### 环境变量使用示例
 
 ```bash

docs/zh-CN/Migration-Guide.md

@@ -370,6 +370,16 @@ docker run -d \
    - 健康检查端点
    - 系统指标
 
+### 可观测与合规
+
+本 fork 还支持：
+
+- **分布式追踪（OpenTelemetry/OTLP）：** 将追踪数据导出到任意兼容 OTLP 的后端。使用 `-tracing-enabled`、`-otlp-endpoint`、`-tracing-service-name`。
+- **审计日志：** 将 hook 执行与请求记录到 file、Redis 或 database。使用 `-audit-enabled`、`-audit-storage-type`、`-audit-file-path` 及相关选项。
+- **基于 Redis 的分布式限流：** 在多实例间共享限流状态。使用 `-redis-enabled`、`-redis-addr`、`-rate-limit-window` 及相关选项。
+
+完整参数与环境变量说明见 [配置参数](CLI-ENV.md)。
+
 ---
 
 ## 迁移检查清单