# @axiomhq/axiom-node 中文文档

规范地址：https://npmcn.com/package/%40axiomhq/axiom-node/

版本：0\.12\.0
npm 元数据更新时间：2026-09-03T13:20:57.462Z
中文译文更新时间：2026-11-07T14:00:14.829Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40axiomhq/axiom-node
原文对照：https://npmcn.com/package/%40axiomhq/axiom-node/?lang=original
项目主页：https://github.com/axiomhq/axiom-node
源码仓库：https://github.com/axiomhq/axiom-node

弃用说明：Please use @axiomhq/js instead

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

- 包体积（解压后）：41.7 kB，23 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=14
- 运行依赖：4 个
- 首次发布：2021-08-26T12:10:39.178Z
- 最新版本发布：2023-05-04T08:14:19.191Z
- 近 30 天下载量：39825（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：13（近 12 个月 0 个）

## 中文简介

Axiom API 的官方节点JS绑定

## 安装

```sh
npm install @axiomhq/axiom-node
```

也可以使用：`pnpm add @axiomhq/axiom-node`、`yarn add @axiomhq/axiom-node`、`bun add @axiomhq/axiom-node`

## README

![axiom-node: The official NodeJS bindings for the Axiom API](https://npmcn.com/package/%40axiomhq/axiom-node/.github/images/banner-dark.svg#gh-dark-mode-only) ![axiom-node: The official NodeJS bindings for the Axiom API](https://npmcn.com/package/%40axiomhq/axiom-node/.github/images/banner-light.svg#gh-light-mode-only)

[![Workflow](https://img.shields.io/github/actions/workflow/status/axiomhq/axiom-node/ci.yml?branch=main&ghcache=unused)](https://github.com/axiomhq/axiom-node/actions/workflows/ci.yml) [![Latest Release](https://img.shields.io/github/release/axiomhq/axiom-node.svg?ghcache=unused)](https://github.com/axiomhq/axiom-node/releases/latest) [![License](https://img.shields.io/github/license/axiomhq/axiom-node.svg?color=blue&ghcache=unused)](https://opensource.org/licenses/MIT)

[轴](https://axiom.co/) 解锁任何尺度的可观察性.

-   **轻而易举地储存:** Axiom 的下一代数据存储器能够以最高效率摄取多字节的数据。 出自库贝内特斯,AWS,Azure,Google Cloud,DigitalOcean,Nomad等地的船舶日志.
-   **询问一切,所有的时间:** 无论是DevOps, SecOps, 还是EverythingOps, 都查询您的所有数据, 不管它的年龄大小 。 不提供数据,不将数据从冷藏/存档转移到“热”上,也不担心询问缓慢。 所有你的数据,所有。 时间.
-   **强力仪表板,用于持续可观察性:** 建立仪表板来收集相关查询,并给出您和您的团队可以快速和轻松地消化的信息. Dashboards可以保密或与他人共享,是汇集不同来源数据的完美方法

详情请查看 [正式文件](https://axiom.co/docs) 我们 [社区迪斯科](https://axiom.co/discord)。 。 。 .

## 快速启动

使用 `npm install`数字 :

```shell
npm install @axiomhq/axiom-node
```

如果你使用 [轴 CLI](https://github.com/axiomhq/cli)运行 `eval $(axiom config export -f)` 来配置环境变量.

否则在 [轴设置](https://app.axiom.co/profile) 并导出为 `AXIOM_TOKEN`设置 `AXIOM_ORG_ID` 转到您想要访问的组织设置页面中的组织ID.

您也可以使用传递给客户端构建者的选项配置客户端:

```ts
const client = new Client({
    token: process.env.AXIOM_TOKEN,
    orgId: process.env.AXIOM_ORG_ID,
});
```

创建和使用这样的客户端 :

```ts
import { Client } from '@axiomhq/axiom-node';

async function main() {
  const client = new Client();

  await client.ingestEvents('my-dataset', [
    { 'foo': 'bar'},
  ]);

  const res = await client.query(`['my-dataset'] | where foo == 'bar' | limit 100`);
}
```

## 使用 Axiom 运输到温斯顿

您可以使用 Winston logger 发送日志到 Axiom 。 首先,安装 `winston` 财务报告和审定财务报表 `@axiomhq/axiom-node` 软件包,然后 创建与 Axiom Transport 的日志实例.

```ts
import winston from 'winston';
import { WinstonTransport as AxiomTransport } from '@axiomhq/axiom-node';

const logger = winston.createLogger({
    level: 'info',
    format: winston.format.json(),
    defaultMeta: { service: 'user-service' },
    transports: [
        new AxiomTransport({
            dataset: 'my-dataset', // defaults to process.env.AXIOM_DATASET
            token: 'my-token', // defaults to process.env.AXIOM_TOKEN
            orgId: 'my-org-id', // defaults to process.env.AXIOM_ORG_ID
        }),
    ],
});
```

关于其他例子,见 [实例](https://npmcn.com/package/%40axiomhq/axiom-node/examples) 目录.

## 许可证

分发于 [MIT 许可证](https://npmcn.com/package/%40axiomhq/axiom-node/LICENSE)。 。 。 .

## 常见问题

### @axiomhq/axiom-node 是什么？

Axiom API 的官方节点JS绑定注意：该包已被作者标记为弃用——Please use @axiomhq/js instead

### 如何安装 @axiomhq/axiom-node？

在项目目录运行 npm install @axiomhq/axiom-node，或使用 pnpm add / yarn add / bun add。

### @axiomhq/axiom-node 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @axiomhq/axiom-node 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @axiomhq/axiom-node 需要什么版本的 Node\.js？

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

### @axiomhq/axiom-node 可以商用吗？

@axiomhq/axiom-node 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @axiomhq/axiom-node 的下载量有多少？

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

### @axiomhq/axiom-node 还在维护吗？

最新版本 0\.12\.0 发布于 2023/05/04（3 年前）；至今共发布 13 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/08/26。作者已将其标记为弃用，新项目建议寻找替代方案。