retaildevcrew/webvalidate

Web Validate (WebV)

镜像概述和主要用途

Web Validate (WebV) 是一款Web请求验证工具，通过JSON日志和Prometheus指标集成到"单一监控面板"，支持构建服务器性能与客户端性能对比的统一监控视图。该工具可作为dotnet全局工具安装，也可通过Docker容器运行，主要用于JSON API测试及深度验证。

核心功能和特性

1. 集成到单一监控面板

   • 支持向stdout和stderr输出JSON格式日志
   • 提供Prometheus指标暴露能力
   • 便于构建统一监控视图，实现服务器性能与客户端性能的对比分析

2. 深度验证任意结果图

   • 专为JSON API测试设计，支持对任意JSON结构进行深度验证
   • 可对API响应的复杂JSON图执行精细校验

使用场景和适用范围

• JSON API接口自动化测试场景
• 需要统一监控服务器与客户端性能的系统
• 对API响应结构有严格验证需求的业务场景
• 需通过Prometheus进行性能指标收集和告警的环境

使用方法和配置说明

Docker运行示例

bash
# 基本运行命令
docker run --name webv -d webv:latest

# 挂载配置文件运行（假设配置文件为webv-config.json）
docker run --name webv -v $(pwd)/webv-config.json:/app/webv-config.json -d webv:latest --config /app/webv-config.json

# 暴露Prometheus指标端口（默认指标端口可通过配置指定）
docker run --name webv -p 9090:9090 -d webv:latest --metrics-port 9090

配置说明

• 日志配置：默认输出JSON格式日志到标准输出/错误流，可通过配置调整日志级别和字段
• 指标配置：支持指定Prometheus指标暴露端口，默认通常为9090
• 验证规则：通过JSON配置文件定义API请求参数和响应验证规则，支持复杂JSON路径校验

日志与指标获取

• JSON日志：直接通过docker logs webv查看容器输出的JSON格式日志
• Prometheus指标：配置Prometheus抓取规则，从容器暴露的指标端口（如9090）收集性能数据