CS Sensor Team Docker 镜像文档

一、镜像概述和主要用途

该镜像为 CS Sensor Team 开发的传感器数据采集与处理系统提供运行环境，集成了传感器驱动、数据接收、预处理及基础分析功能。主要用于工业环境、实验室或物联网场景下的多类型传感器数据实时采集、标准化处理和数据转发，支持与各类监控平台、数据库或云服务集成。

二、核心功能和特性

核心功能

• 支持多协议传感器接入（Modbus、MQTT、HTTP、TCP/UDP）
• 实时数据采集与本地缓存
• 数据格式标准化与清洗
• 定时/触发式数据转发
• 基础数据统计分析（均值、极值、异常检测）

特性

• 轻量化设计，资源占用低（内存 ≤ 256MB，CPU ≤ 10%）
• 模块化架构，支持传感器驱动扩展
• 配置文件驱动，支持动态参数调整
• 内置健康检查与自动恢复机制
• 兼容 x86_64 和 ARM 架构

三、使用场景和适用范围

适用场景

• 工业生产线传感器数据监控
• 环境监测系统（温湿度、气压、空气质量等）
• 实验室设备数据采集与记录
• 物联网边缘节点数据预处理
• 传感器网络测试与调试

适用范围

• 操作系统：Linux（Ubuntu 18.04+、CentOS 7+）
• 硬件架构：x86_64、ARMv7、ARM64
• 传感器类型：支持标准协议的工业传感器、环境传感器、运动传感器等

四、使用方法和配置说明

1. 镜像获取

bash
# 从私有仓库拉取（示例）
docker pull registry.example.com/cs-sensor-team/sensor-collector:latest

# 或本地构建
docker build -t cs-sensor-team/sensor-collector:latest .

2. 基础运行命令

bash
docker run -d \
  --name sensor-collector \
  --restart always \
  -p 8080:8080 \
  -v ./config:/app/config \
  -v ./data:/app/data \
  cs-sensor-team/sensor-collector:latest

3. 配置文件说明

配置文件路径：/app/config/config.yaml（通过挂载目录实现外部配置）

基础配置结构：

yaml
# 服务配置
service:
  port: 8080          # 服务端口
  log_level: info     # 日志级别（debug/info/warn/error）
  buffer_size: 1000   # 数据缓冲区大小

# 传感器配置（支持多传感器）
sensors:
  - id: "sensor_01"           # 传感器ID（唯一）
    type: "modbus"            # 传感器类型（modbus/mqtt/http/tcp）
    enable: true              # 是否启用
    interval: 5               # 采集间隔（秒）
    connection:
      host: "192.168.1.100"   # 传感器IP/主机名
      port: 502               # 端口
      timeout: 3              # 连接超时（秒）
    parameters:               # 传感器特定参数
      slave_id: 1
      register: 0x0000
      count: 2

# 数据转发配置（支持多目标）
forwarders:
  - type: "http"              # 转发类型（http/mqtt/influxdb/mysql）
    enable: true
    url: "[***]"  # 目标地址
    method: "POST"            # 请求方法
    interval: 10              # 转发间隔（秒）
    batch_size: 50            # 批量转发大小

4. 环境变量说明

五、Docker Compose 部署示例

docker-compose.yml:

yaml
version: '3.8'

services:
  sensor-collector:
    image: cs-sensor-team/sensor-collector:latest
    container_name: sensor-collector
    restart: always
    ports:
      - "8080:8080"
    volumes:
      - ./config:/app/config
      - ./data:/app/data
      - ./logs:/app/logs
    environment:
      - LOG_LEVEL=debug
      - HEALTH_CHECK_INTERVAL=5
    networks:
      - sensor-network
    depends_on:
      - influxdb  # 可选：若使用influxdb作为数据存储

  # 可选：数据存储服务（示例）
  influxdb:
    image: influxdb:1.8
    container_name: sensor-influxdb
    restart: always
    ports:
      - "8086:8086"
    volumes:
      - influxdb-data:/var/lib/influxdb
    environment:
      - INFLUXDB_DB=sensor_data
      - INFLUXDB_USER=admin
      - INFLUXDB_USER_PASSWORD=password
    networks:
      - sensor-network

networks:
  sensor-network:
    driver: bridge

volumes:
  influxdb-data:

启动命令：docker-compose up -d

六、数据持久化与备份

• 数据存储路径：/app/data（包含缓存数据、本地备份文件）
• 备份方法：通过外部挂载的 ./data 目录直接备份宿主机文件
• 日志路径：/app/logs（可通过环境变量 LOG_PATH 修改）

七、健康检查与监控

• 健康检查接口：http://<ip>:8080/health
  • 正常响应：{"status": "ok", "timestamp": "2023-10-01T12:00:00Z", "sensors": 3, "active_sensors": 3}
• 指标接口：http://<ip>:8080/metrics（Prometheus格式指标）
  • 主要指标：采集成功率、数据转发成功率、缓存使用率、传感器连接状态等

八、常见问题解决

1. 传感器连接失败

   • 检查网络连通性：docker exec -it sensor-collector ping <sensor_ip>
   • 确认传感器配置参数（IP、端口、协议类型）是否正确
   • 查看日志：docker logs -f sensor-collector

2. 数据转发延迟

   • 检查目标服务是否正常运行
   • 调整转发配置的 interval 和 batch_size 参数
   • 检查网络带宽和延迟

3. 服务启动失败

   • 检查配置文件格式：docker exec -it sensor-collector /app/validate-config
   • 确认挂载目录权限：宿主机配置目录权限需设为 755

九、版本信息

注：完整文档及更新日志请参考项目仓库：[***]