krillsson/sys-api

sys-API 镜像文档

概述

sys-API（System API）是一个提供GraphQL和RESTful API接口的硬件监控工具，能够通过https://github.com/oshi/oshi%E5%BA%93%E5%92%8Chttps://github.com/dropwizard/dropwizard%E6%A1%86%E6%9E%B6%E5%8F%91%E5%B8%83%E5%B9%B6%E7%9B%91%E6%8E%A7%E8%AE%A1%E7%AE%97%E6%9C%BA%E7%A1%AC%E4%BB%B6%E4%BF%A1%E6%81%AF%E3%80%82%E5%9C%A8Windows%E7%B3%BB%E7%BB%9F%E4%B8%AD%EF%BC%8C%E8%BF%98%E4%BC%9A%E5%80%9F%E5%8A%A9https://github.com/openhardwaremonitor/openhardwaremonitor%E5%92%8Chttps://github.com/Krillsson/ohmjni4net%E8%A1%A5%E5%85%85%E7%A1%AC%E4%BB%B6%E6%95%B0%E6%8D%AE%E3%80%82

项目GitHub地址：https://github.com/Krillsson/sys-API

核心功能与特性

• 双API支持：同时提供GraphQL和RESTful API接口，方便不同场景下的数据获取需求
• 硬件监控能力：基于OSHI库获取系统硬件信息，包括CPU、内存、磁盘、网络等
• 跨平台增强：Windows系统额外集成OpenHardwareMonitor和OhmJni4Net，提升硬件数据采集能力
• Docker集成：支持通过Docker管理API监控容器状态
• 主机级访问：可配置主机网络模式和进程访问权限，确保硬件数据采集准确性
• 灵活存储：支持数据和配置目录挂载，持久化存储监控数据和配置信息

使用场景与适用范围

• 家庭服务器硬件状态监控
• 个人计算机硬件信息采集与分析
• 需要通过API获取硬件数据的应用集成
• Docker容器环境的硬件与容器状态联合监控

使用方法与配置说明

Docker Compose配置示例

yaml
version: "3"
services:
  sys-api:
    container_name: sys-api
    image: krillsson/sys-api:latest
    # 暴露网络接口卡供sys-API读取
    network_mode: host
    # 如果不想使用network_mode: host，请取消注释以下端口映射
    # ports:
    # - "8080:8080"
    # - "8443:8443"
    #  # Docker管理API端口
    # - "2375:2375"
    # 暴露主机进程给容器
    pid: "host"
    volumes:
      # 将"/path/to/*"替换为您机器上的实际目录
      - /path/to/data:/data
      - /path/to/config:/config
      # Docker管理API的socket文件
      - /var/run/docker.sock:/var/run/docker.sock
      # 用于读取磁盘设备名称
      - /run/udev:/run/udev:ro
      # 允许sys-API访问读取硬盘信息
      # 也可单独挂载需要监控的设备
      - /dev:/dev:ro
      # 同上
      - /srv:/srv:ro
    restart: unless-stopped

关键配置说明

网络配置

• network_mode: host：容器使用主机网络模式，可直接访问主机网络接口卡（NIC），推荐用于硬件监控场景
• 端口映射（可选）：若不使用主机网络模式，需手动映射端口（8080/8443为API端口，2375为Docker管理API端口）

进程访问

• pid: "host"：容器使用主机进程命名空间，允许访问主机进程信息，提升硬件监控准确性

卷挂载

• /path/to/data:/data：数据持久化目录，需替换为本地实际目录
• /path/to/config:/config：配置文件目录，需替换为本地实际目录
• /var/run/docker.sock:/var/run/docker.sock：Docker管理API的socket文件，用于监控Docker容器
• /run/udev:/run/udev:ro：只读挂载udev目录，用于读取磁盘设备名称
• /dev:/dev:ro：只读挂载设备目录，允许访问硬盘信息（也可单独挂载特定设备）
• /srv:/srv:ro：只读挂载srv目录，辅助访问存储设备信息

部署注意事项

• 确保挂载目录具有正确权限，避免因权限不足导致硬件信息读取失败
• Windows系统可能需要额外配置OpenHardwareMonitor相关依赖
• 生产环境建议使用固定版本镜像（如krillsson/sys-api:vX.Y.Z）而非latest，确保版本稳定性