# @defra/cdp-auditing 中文文档

规范地址：https://npmcn.com/package/%40defra/cdp-auditing/

版本：0\.6\.3
npm 元数据更新时间：2026-11-03T16:18:58.035Z
中文译文更新时间：2026-11-11T21:03:05.736Z
软件包许可：OGL-UK-3\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40defra/cdp-auditing
原文对照：https://npmcn.com/package/%40defra/cdp-auditing/?lang=original
项目主页：https://github.com/DEFRA/cdp-libraries/tree/main/packages/cdp-auditing#readme
源码仓库：https://github.com/DEFRA/cdp-libraries

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：8.1 kB，7 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22
- 运行依赖：1 个
- 首次发布：2025-07-04T13:31:03.165Z
- 最新版本发布：2026-11-03T16:18:57.685Z
- 近 30 天下载量：46394（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：10（近 12 个月 4 个）

## 中文简介

发送审计信息给 CDP 审计管道的 hopi 插件

## 安装

```sh
npm install @defra/cdp-auditing
```

也可以使用：`pnpm add @defra/cdp-auditing`、`yarn add @defra/cdp-auditing`、`bun add @defra/cdp-auditing`

## README

# CDP 审计

这个软件包允许服务向CDP审计流写出审计信息.

## 安装

```bash
npm i @defra/cdp-auditing
```

## 使用量

Cdp-审计库并不十分复杂.

### 基本审计

向审计流程发送信息,只需导入审计库并拨打 `audit()` 函数.

```js
import { audit } from '@defra/cdp-auditing'
audit('This is a test of auditing')
// {"log.level":"audit","time":"2025-07-04T11:46:33.278Z","msg":"This is a test of auditing"}
```

### 审计结构化数据

也可以将结构化数据写入审计流. 传入的值应该像Json一样可以序列.

```js
audit({ id: '1234', event: 'login', outcome: 'denied' }, 'Login failed')
// {"log.level":"audit","time":"2025-07-04T11:46:33.278Z","id":"1234","event":"login","outcome":"denied","msg":"Login failed"}

audit({ id: '1234', event: 'login', outcome: 'denied' })
// {"log.level":"audit","time":"2025-07-04T11:46:33.278Z","id":"1234","event":"login","outcome":"denied"}
```

当本地运行时,审计信息会被打印到控制台上,以便您看到哪些数据会进行审计.

默认情况下可以进行审计。 要开启或关闭审计,您可以拨打:

```js
import { audit, enableAuditing } from '@defra/cdp-auditing'

// Turn auditing off
enableAuditing(false)

// Re-enable auditing
enableAuditing()
// or
enableAuditing(true)
```

## CDP平台上的审计工作

审计基本上只是预先配置的标准记录器,以完成以下工作:

-   写到控制台/ studout
-   以 JSON 写出所有信件
-   确保所有信件包含ECS样式 `log.level` 设置为 `audit`

在CDP平台上运行的服务部署有日志收集辅助车(FluentBit).

日志侧车根据它们过滤信件 `log.level` 字段。 信件带有 `"log.level": "audit"` 为: 已过滤出并发送到审计流,而所有其他日志级别则被发送到OpenSearch管道.

## 常见问题

### @defra/cdp-auditing 是什么？

发送审计信息给 CDP 审计管道的 hopi 插件

### 如何安装 @defra/cdp-auditing？

在项目目录运行 npm install @defra/cdp-auditing，或使用 pnpm add / yarn add / bun add。

### @defra/cdp-auditing 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/defra\_\_cdp-auditing 是否存在。

### @defra/cdp-auditing 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @defra/cdp-auditing 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @defra/cdp-auditing 可以商用吗？

@defra/cdp-auditing 使用 OGL-UK-3\.0 许可。声明的许可为 OGL-UK-3\.0，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @defra/cdp-auditing 的下载量有多少？

根据 npm 官方下载统计，@defra/cdp-auditing 在 2026/10/12 – 2026/11/10 这 30 天内被下载 46,394 次，日均约 1,546 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @defra/cdp-auditing 还在维护吗？

最新版本 0\.6\.3 发布于 2026/11/04（8 天前）；至今共发布 10 个版本，其中过去 12 个月发布了 4 个；首次发布于 2025/07/04。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。