diff --git a/README.md b/README.md index 0e6b06b..7a22b7e 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ src/fault_log_analyzer/ # 安装(核心零依赖,可选依赖见 requirements.txt) pip install -e . -# 运行单元测试 +# 运行单元测试(131 个测试用例) python -m unittest discover -s tests -v # 启动服务(内存存储,便于本地验证) @@ -49,6 +49,17 @@ curl http://127.0.0.1:8080/healthz curl http://127.0.0.1:8080/api/v1/fault-logs ``` +## 测试 + +```bash +python -m unittest discover -s tests -v +# Ran 131 tests ... OK +``` + +测试覆盖:配置加载、数据模型、日志解析/模板化、故障过滤规则、MinHash 指纹去重、 +TF-IDF/DBSCAN 聚类、故障归类、根因分析、捕获管道、聚类/根因 worker、REST API、 +以及 Kafka/Elasticsearch/MySQL/Redis 可选后端适配器(未安装依赖时的回退行为与索引名)。 + ## 环境变量(生产) | 变量 | 默认值 | 说明 | @@ -63,3 +74,9 @@ curl http://127.0.0.1:8080/api/v1/fault-logs | `CLUSTER_EPS` | `0.75` | DBSCAN eps(余弦距离) | | `CLUSTER_MIN_SAMPLES` | `5` | DBSCAN min_samples | | `ROOT_CAUSE_WINDOW_MINUTES` | `5` | 根因分析时间窗口 | + +## 开发说明 + +- 模块状态:`modules/fault-log-analyzer.md` +- 开发说明:`docs/02-develop/fault-log-analyzer-dev-notes.md` +- 设计依据:`docs/01-design/architecture.md`(5.3)、`database-design.md`、`api-design.md`