Capture

开源硬件监控代理

Capture 是一款硬件监控代理，可从主机收集硬件信息并通过 RESTful API 公开这些信息。该代理设计轻巧且易于使用。

• 功能
• 快速开始（Docker）
• 快速开始（Docker Compose）
• 配置
• 安装选项
• Docker（推荐）
• Helm
• 系统安装
• Linux Systemd 服务
• macOS Launchd 服务
• Windows 服务
• 反向代理与 SSL
• Caddy
• 端点
• API 文档
• 贡献指南
• 星标历史
• 许可证

功能

• CPU 监控
  • 温度
  • 负载
  • 频率
  • 使用率
• 内存监控
• 磁盘监控
  • 使用率
  • Inode 使用率
  • 读写字节数
  • S.M.A.R.T. 监控（自我监控、分析与报告技术）
• 网络监控
• Docker 容器监控
• GPU 监控（即将推出）

快速开始（Docker）

docker run -d \
-v /etc/os-release:/etc/os-release:ro \
-p 59232:59232 \
-e API_SECRET=your-secret-key \
ghcr.io/bluewave-labs/capture:latest

快速开始（Docker Compose）

services:
  # Capture 服务
  capture:
    image: ghcr.io/bluewave-labs/capture:latest
    container_name: capture
    restart: unless-stopped
    ports:
      - "59232:59232"
    environment:
      - API_SECRET=REPLACE_WITH_YOUR_SECRET # 必需的认证密钥。不要忘记用您的实际密钥替换此值。
      - GIN_MODE=release
    volumes:
      - /etc/os-release:/etc/os-release:ro

配置

配置示例：

# 最小配置
API_SECRET=your-secret-key ./capture

# 完整配置
API_SECRET=your-secret-key PORT=59232 GIN_MODE=release ./capture

安装选项

Docker（推荐）

拉取并运行官方镜像：

docker run -d \
-v /etc/os-release:/etc/os-release:ro \
-p 59232:59232 \
-e API_SECRET=your-secret-key \
ghcr.io/bluewave-labs/capture:latest

或本地构建：

docker buildx build -t capture .
docker run -d -v /etc/os-release:/etc/os-release:ro -p 59232:59232 -e API_SECRET=your-secret-key capture

Docker 选项说明：

• -v /etc/os-release:/etc/os-release:ro：平台检测
• -p 59232:59232：端口映射
• -e API_SECRET：必需的认证密钥
• -d：后台运行模式

Helm

您可以使用提供的 Helm Chart 在 Kubernetes 集群上部署 Capture。

1. 进入 Helm Chart 目录：

cd deployment/helm/capture

2. 自定义 values.yaml 并设置您的 API_SECRET。

3. 安装 Chart：

helm install capture .

有关详细说明，请参阅 Helm 安装指南。

系统安装

选择以下方法之一：

1. 预构建二进制文件：从 https://github.com/bluewave-labs/capture/releases 下载

2. Go 包：

go install github.com/bluewave-labs/capture/cmd/capture@latest

3. 从源码构建：

git clone git@github.com:bluewave-labs/capture
cd capture
just build # 或：go build -o dist/capture ./cmd/capture/

Linux Systemd 服务

在 deployment/linux/install.sh 提供了安装脚本。它会自动检测您的 CPU 架构，从 GitHub 下载最新版本，将二进制文件安装到 /usr/local/bin，并注册 systemd 服务。

要求：curl、tar 以及运行 systemd 的系统。必须以 root 身份运行。

1. 一步下载并运行：

curl -fsSL https://raw.githubusercontent.com/bluewave-labs/capture/main/deployment/linux/install.sh | sudo bash

如果未作为参数提供，脚本会提示您输入 API_SECRET。

2. 如偏好，可内联提供选项：

curl -fsSL https://raw.githubusercontent.com/bluewave-labs/capture/main/deployment/linux/install.sh \
| sudo bash -s -- --api-secret "your-secret-key"

3. 所有可用选项：

curl -fsSL https://raw.githubusercontent.com/bluewave-labs/capture/main/deployment/linux/install.sh \
| sudo bash -s -- \
--api-secret "your-secret-key" \
--port 59232 \
--install-dir /usr/local/bin \
--service-name capture

或先下载脚本再本地运行：

curl -fsSL -o install.sh https://raw.githubusercontent.com/bluewave-labs/capture/main/deployment/linux/install.sh
sudo bash install.sh --api-secret "your-secret-key"

4. 完整选项参考：

5. 安装后，使用 systemctl 管理服务：

systemctl status capture
systemctl stop capture
systemctl start capture
systemctl restart capture
journalctl -u capture -f

手动设置

如果您偏好手动配置服务，在 deployment/linux/capture.service 提供了服务文件模板。

1. 编辑服务文件，设置您的二进制路径、用户、组和密钥：

nano deployment/linux/capture.service

2. 将其复制到 systemd 单元目录：

cp deployment/linux/capture.service /etc/systemd/system/

3. 重新加载、启用并启动服务：

systemctl daemon-reload
systemctl enable capture
systemctl start capture

4. 验证服务是否运行：

systemctl status capture

macOS Launchd 服务

在 deployment/macos/install.sh 提供了安装脚本。它会自动检测您的 CPU 架构，从 GitHub 下载最新版本，将二进制文件安装到 /usr/local/bin，并注册系统级 launchd 守护进程。

要求：curl、tar、macOS 以及通过 sudo 获得的 root 权限。

1. 一步下载并运行：

Windows Service

PowerShell安装脚本位于 deployment/windows/install.ps1。它会自动检测CPU架构，从GitHub下载最新版本，安装二进制文件并注册Windows服务。

要求： PowerShell 5.1+ 和管理员终端。

1. 以管理员身份打开PowerShell并一步运行：

Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
Invoke-RestMethod https://raw.githubusercontent.com/bluewave-labs/capture/main/deployment/windows/install.ps1 | Invoke-Expression

如果未作为参数提供，脚本会提示您输入 API_SECRET。

2. 如偏好，可内联提供参数：

& ([scriptblock]::Create(
(Invoke-RestMethod https://raw.githubusercontent.com/bluewave-labs/capture/main/deployment/windows/install.ps1)
)) -APISecret "your-secret-key"

3. 所有可用参数：

& ([scriptblock]::Create(
(Invoke-RestMethod https://raw.githubusercontent.com/bluewave-labs/capture/main/deployment/windows/install.ps1)
)) -APISecret "your-secret-key" -Port 59232 -InstallDir "C:\Program Files\Capture" -ServiceName "capture"

或者先下载脚本并在本地运行：

Invoke-RestMethod https://raw.githubusercontent.com/bluewave-labs/capture/main/deployment/windows/install.ps1 -OutFile install.ps1
Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
.\install.ps1 -APISecret "your-secret-key"

4. 完整参数参考：

5. 安装后，使用标准PowerShell cmdlet管理服务：

Get-Service capture
Stop-Service capture
Start-Service capture
Restart-Service capture

{
"data": {
// 收集器特定的负载
},
"capture": {
"version": "1.0.0",
"mode": "release"
},
"errors": [
// 可选的错误消息数组（如果有收集器失败），可为 null
],
}

收集器可能会部分失败；发生这种情况时，API 会返回 HTTP 207 Multi-Status 响应，并在 errors 中填充详细原因，以便您可以在不丢弃其他指标数据的情况下发出警报。

API 文档

我们的 API 按照 OpenAPI 规范进行文档化。

您可以在 https://github.com/bluewave-labs/capture/blob/develop/openapi.yml 中找到 OpenAPI 规范。

贡献指南

我们欢迎贡献！如果您想贡献，请阅读 CONTRIBUTING.md 文件了解更多信息。

Star History

许可证

Capture 采用 AGPLv3 许可证。您可以在 LICENSE 文件中找到许可证内容。