scriptrock/guardrail_agent

ScriptRock Guardrail Agent / Connection Manager 镜像文档

概述

ScriptRock Guardrail Agent / Connection Manager 是 ScriptRock Guardrail 系统的核心组件之一，主要负责管理客户端与 Guardrail 系统之间的连接、数据传输及代理功能，确保客户端与 Guardrail 服务器之间的稳定通信和数据交互，是部署和运行 Guardrail 系统的关键支撑组件。

核心功能与特性

• 连接管理：建立和维护与 Guardrail 服务器的稳定连接，支持自动重连机制，保障连接的持续性。
• 数据传输代理：作为客户端与 Guardrail 服务器之间的代理组件，转发数据请求与响应，确保数据传输的完整性和安全性。
• 连接状态监控：实时监控连接状态，提供连接健康检查、异常告警及状态报告功能，便于运维人员掌握通信状况。
• 灵活配置：支持通过环境变量或配置文件进行参数配置，适配不同部署场景下的连接需求（如服务器地址、端口、认证信息等）。
• 日志与审计：记录连接活动日志、数据传输详情及异常事件，支持审计追溯和问题排查。

使用场景与适用范围

• 企业 Guardrail 系统部署：在企业环境中部署 Guardrail 系统时，作为客户端代理组件连接至 Guardrail 服务器，实现客户端与服务器的双向数据交互。
• 分布式环境连接管理：在多节点分布式架构中，统一管理各客户端节点与 Guardrail 系统的连接，确保分布式环境下的通信一致性和可靠性。
• 安全代理场景：在需通过代理进行安全通信的环境中（如隔离网络、防火墙限制场景），作为 Guardrail 系统的专用代理组件，保障数据传输的安全性与合规性。

使用方法与配置说明

基本部署命令

通过以下 Docker 命令启动容器：

bash
docker run -d \
  --name guardrail-agent \
  -e GUARDRAIL_SERVER_HOST=guardrail-server.example.com \
  -e GUARDRAIL_SERVER_PORT=443 \
  -e AGENT_AUTH_TOKEN=your-auth-token \
  -v /path/to/agent/config:/etc/guardrail/agent \
  -v /path/to/agent/logs:/var/log/guardrail/agent \
  scriptrock/guardrail-agent:latest

环境变量配置

容器支持通过环境变量配置核心参数，常用配置如下：

卷挂载说明

建议挂载以下目录以实现配置持久化和日志存储：

• /etc/guardrail/agent：配置文件目录，可挂载本地配置文件（如 config.yaml）覆盖默认配置。
• /var/log/guardrail/agent：日志存储目录，挂载本地目录以持久化保存连接日志、传输日志等。

配置文件说明

若需通过配置文件自定义更多参数，可在挂载的 /etc/guardrail/agent 目录下创建 config.yaml，示例配置如下：

yaml
server:
  host: guardrail-server.example.com  # Guardrail 服务器地址
  port: 443                          # 服务器端口
auth:
  token: your-auth-token             # 认证令牌
connection:
  timeout: 30                        # 连接超时时间（秒）
  reconnect_interval: 10             # 重连间隔（秒）
  max_reconnect_attempts: 0          # 最大重连次数（0 表示无限重试）
logging:
  level: INFO                        # 日志级别
  file_path: /var/log/guardrail/agent/agent.log  # 日志文件路径
  max_file_size: 100                 # 单个日志文件大小上限（MB）
  max_backup_count: 5                # 日志文件备份数量

日志查看与健康检查

• 查看日志：通过 docker logs guardrail-agent 命令查看实时日志，或直接访问挂载的日志文件目录。
• 健康检查：容器内置健康检查机制，可通过 docker inspect --format '{{.State.Health.Status}}' guardrail-agent 命令查看当前健康状态（返回 healthy 表示连接正常）。