@contrast/reporter
订阅代理信件, 并将其报告给 Contrast UI, 安全日志或文件 .
报告采用出版/订阅模式。 代理组件发布事件
core.messages (活动名称是: Event 来自 @contrast/common),以及
每个记者都订阅它关心的事件. 记者也可以
发布,例如对比 UI 的记者发布 Event.SERVER_SETTINGS_UPDATE 何时
新的远程设置到达 .
记者
| 记者 | 启用时间 |
|---|
| 对比UI | api.enable 实值 true |
| 安全记录器 | protect.enable 实值 true,除非 agent.security_logger.path 实值 /dev/null 财务报告和审定财务报表 agent.security_logger.stdout 实值 false |
| 文件 | agent.reporters.file 设置到路径 |
对比UI的记者也登入了代理:其代理和应用程序
启动请求返回远程
其它代理商的设置和资格取决于。 这就是为什么
记者在任何其他代理组件之前安装.
安全记录员将保护攻击等安全事件写成一个档案,
stdout, 或 syslog 根据 agent.security_logger.* 选项.
使用量
@contrast/agentify 将记者编成核心 core.reporter.install()
安装每个启用的记者.
const { Event } = require('@contrast/common');
core.messages.emit(Event.PROTECT_FINDING, finding);
关于 @contrast/reporter 的常见问题
@contrast/reporter 是什么？
订阅代理信件并报告
如何安装 @contrast/reporter？
在项目目录运行 npm install @contrast/reporter，或使用 pnpm add / yarn add / bun add。
@contrast/reporter 支持 TypeScript 吗？
支持。包内自带 TypeScript 类型声明（package.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。
@contrast/reporter 支持 ESM 还是 CommonJS？
以 CommonJS 形式发布，可以直接 require()；在 ES Module 项目中也可以用 import 引入（Node.js 会把 module.exports 作为默认导出）。
@contrast/reporter 需要什么版本的 Node.js？
package.json 的 engines 字段要求 Node.js >=20.9.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。
@contrast/reporter 可以商用吗？
@contrast/reporter 使用 SEE LICENSE IN LICENSE 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。
@contrast/reporter 的下载量有多少？
根据 npm 官方下载统计，@contrast/reporter 在 2026/10/11 – 2026/11/09 这 30 天内被下载 16,400 次，日均约 547 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
@contrast/reporter 还在维护吗？
最新版本 1.71.1 发布于 2026/11/05（6 天前）；至今共发布 108 个版本，其中过去 12 个月发布了 21 个；首次发布于 2022/06/16。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。