tsuru/bs

bs 镜像文档

镜像概述和主要用途

bs（big sibling）是tsuru平台的核心组件，运行在每个Docker节点的专用容器中。其主要功能是监控并收集同节点上应用容器的关键信息，包括应用日志、性能指标和单元状态，并将这些信息报告给tsuru API。此外，bs还作为syslog服务器接收容器日志，并支持将日志转发到多个远程syslog端点。

核心功能和特性

状态报告

• Docker API通信：通过TCP或Unix Socket（推荐，增强安全性）连接Docker API，收集容器信息。
• 信息上报：将收集的容器数据报告给tsuru API。
• 僵尸容器处理：检测并终止tsuru未管理但仍在运行的应用容器，不影响非tsuru管理的容器。

日志功能

• syslog服务器：作为syslog服务端，接收Docker容器通过syslog日志驱动发送的日志。
• 日志转发：将日志转发到tsuru API（供用户通过tsuru app-log命令查看），并支持转发到多个远程syslog端点。

指标收集

• 指标类型：收集容器的cpu_max（最大CPU使用率）、mem_max（最大内存使用量）、mem_pct_max（最大内存使用率百分比）。
• 后端支持：支持将指标发送到statsd或logstash后端。

使用场景和适用范围

适用于tsuru平台环境，用于集中监控和管理Docker节点上的应用容器。适合需要实时掌握容器运行状态、集中收集应用日志、监控容器性能指标的场景，帮助管理员和开发者及时发现并处理容器异常。

详细使用方法和配置说明

环境变量配置

通过在bs容器中设置环境变量进行功能配置，可使用tsuru-admin bs-env-set命令管理。主要环境变量说明如下：

STATUS_INTERVAL

• 描述：状态收集和上报的时间间隔（秒）
• 默认值：60
• 示例：STATUS_INTERVAL=30（每30秒执行一次状态报告）

SYSLOG_FORWARD_ADDRESSES

• 描述：日志转发的远程syslog端点列表，逗号分隔
• 默认值：空字符串（仅转发到tsuru API）
• 示例：SYSLOG_FORWARD_ADDRESSES=syslog://logserver1:514,syslog://logserver2:514

SYSLOG_TIMEZONE

• 描述：转发日志时使用的时区
• 格式：需为IANA时区数据库中的有效时区（如Asia/Shanghai）
• 示例：SYSLOG_TIMEZONE=Asia/Shanghai

METRICS_INTERVAL

• 描述：指标收集和上报的时间间隔（秒）
• 默认值：60
• 示例：METRICS_INTERVAL=10（每10秒收集一次指标）

METRICS_BACKEND

• 描述：指标存储后端类型
• 支持值：statsd、logstash
• 示例：METRICS_BACKEND=statsd

METRICS_LOGSTASH_CLIENT

• 描述：发送指标到Logstash时的客户端标识
• 默认值：tsuru
• 示例：METRICS_LOGSTASH_CLIENT=prod-tsuru

METRICS_LOGSTASH_PORT

• 描述：Logstash服务端口
• 默认值：1984
• 示例：METRICS_LOGSTASH_PORT=5000

METRICS_LOGSTASH_HOST

• 描述：Logstash服务主机地址
• 默认值：localhost
• 示例：METRICS_LOGSTASH_HOST=logstash.prod.com

METRICS_ELASTICSEARCH_HOST

• 描述：Elasticsearch服务主机地址，供tsuru-dashboard展示指标图表
• 示例：METRICS_ELASTICSEARCH_HOST=es.prod.com

METRICS_STATSD_PREFIX

• 描述：Statsd指标键前缀，完整键格式为{prefix}tsuru.{appname}.{hostname}
• 默认值：空字符串
• 示例：METRICS_STATSD_PREFIX=prod.（生成指标键如prod.tsuru.myapp.node1）

METRICS_STATSD_PORT

• 描述：Statsd服务端口
• 默认值：8125
• 示例：METRICS_STATSD_PORT=8126

METRICS_STATSD_HOST

• 描述：Statsd服务主机地址
• 默认值：localhost
• 示例：METRICS_STATSD_HOST=statsd.prod.com

BS_DEBUG

• 描述：是否启用调试日志
• 默认值：false
• 示例：BS_DEBUG=true（启用调试日志输出）

Docker部署示例

使用Unix Socket连接Docker API，配置状态报告间隔30秒，转发日志到远程syslog服务器，并启用Statsd指标收集：

bash
docker run -d \
  --name bs \
  -v /var/run/docker.sock:/var/run/docker.sock \  # 挂载Docker Unix Socket
  -e STATUS_INTERVAL=30 \
  -e SYSLOG_FORWARD_ADDRESSES=syslog://syslog.prod.com:514 \
  -e SYSLOG_TIMEZONE=Asia/Shanghai \
  -e METRICS_BACKEND=statsd \
  -e METRICS_STATSD_HOST=statsd.prod.com \
  -e METRICS_STATSD_PREFIX=prod. \
  tsuru/bs