nmtwizard/score

Score Utility Docker镜像文档

镜像概述和主要用途

Score Utility Docker镜像是net-wizard提供的一款轻量级评分工具容器化版本，旨在简化对网络、系统或应用程序的评估流程。该工具通过预设的评估指标对目标对象进行检测，自动生成直观的评分报告，帮助用户快速了解目标对象的性能表现、健康状况或功能完整性，适用于开发、测试及运维场景中的快速评估需求。

核心功能和特性

• 轻量级设计：镜像体积小，资源占用低，可在各种环境中快速部署和运行
• 多场景支持：支持网络性能、系统健康状态、应用程序功能等多种评估场景
• 自动化评分：内置多种评估指标和算法，自动完成检测并生成评分结果
• 报告生成：支持多种格式（如JSON、TXT、HTML）的评分报告输出
• 易配置：通过环境变量或配置文件灵活调整评估参数和指标权重

使用场景和适用范围

适用场景

• 网络管理员评估网络设备或链路的性能评分
• 系统管理员检测服务器或集群的健康状态评分
• 开发人员在测试环境中评估应用程序的功能完整性评分
• 运维团队定期对生产环境进行自动化健康检查和评分

适用范围

• 个人开发者、小型团队到企业级环境
• 支持Linux、Windows、macOS等主流操作系统的Docker环境
• 兼容x86_64和ARM架构

使用方法和配置说明

前提条件

• 已安装Docker Engine（推荐版本20.10+）
• 网络环境可访问Docker Hub或私有镜像仓库（若使用私有镜像）

获取镜像

从Docker Hub拉取最新版本：

bash
docker pull net-wizard/score-utility:latest

若使用特定版本，可指定标签：

bash
docker pull net-wizard/score-utility:1.0.0

基本使用方法

命令行直接运行

bash
docker run --rm net-wizard/score-utility:latest --target <评估目标> --output <报告格式>

示例：评估本地网络性能并生成JSON报告

bash
docker run --rm net-wizard/score-utility:latest --target network --output json

通过配置文件运行

1. 创建本地配置文件（如config.yaml）：

yaml
target: system
metrics:
  cpu: true
  memory: true
  disk: true
report:
  format: html
  path: /reports/score.html

2. 挂载配置文件并运行容器：

bash
docker run --rm -v $(pwd)/config.yaml:/app/config.yaml -v $(pwd)/reports:/reports net-wizard/score-utility:latest --config /app/config.yaml

配置参数说明

命令行参数

环境变量

Docker Compose示例

创建docker-compose.yml文件：

yaml
version: '3'
services:
  score-utility:
    image: net-wizard/score-utility:latest
    environment:
      - SCORE_LOG_LEVEL=debug
      - SCORE_TIMEOUT=600
    volumes:
      - ./config:/app/config
      - ./reports:/app/reports
    command: --config /app/config/custom.yaml --output html

运行：

bash
docker-compose up

注意事项

• 评估网络或远程系统时，需确保容器具有相应的网络访问权限
• 挂载宿主机目录时，注意文件权限设置，避免因权限问题导致报告生成失败
• 对于高资源消耗的评估任务，建议适当调整容器的CPU和内存限制