# @chax-at/gelf-client 中文文档

规范地址：https://npmcn.com/package/%40chax-at/gelf-client/

版本：1\.0\.2
npm 元数据更新时间：2025-09-24T11:13:25.747Z
中文译文更新时间：2026-11-09T11:54:41.445Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40chax-at/gelf-client
原文对照：https://npmcn.com/package/%40chax-at/gelf-client/?lang=original

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

- 包体积（解压后）：30.6 kB，35 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2022-02-10T10:46:35.627Z
- 最新版本发布：2025-07-17T15:00:47.817Z
- 近 30 天下载量：3728（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 0 个）

## 中文简介

一个简单的Gelf客户端用于节点. 目前支持TCP和TCP/TLS.

## 安装

```sh
npm install @chax-at/gelf-client
```

也可以使用：`pnpm add @chax-at/gelf-client`、`yarn add @chax-at/gelf-client`、`bun add @chax-at/gelf-client`

## README

## 格尔夫客户

一个简单的Gelf客户端用于节点. 目前支持TCP和TCP/TLS.

字段默认为1000个字符. 这是可塑的.

### 使用量

```typescript
import {SecureTCPTransport, GelfClient} from "gelf-client";

const secureTransport = new SecureTCPTransport({
    host: 'localhost',
    port: 15150,
    ca: fs.readFileSync('server.crt'),      // for self-signed server certs
    key: fs.readFileSync('client.key'),     // for TLS client auth
    cert: fs.readFileSync('client.cert'),   // for TLS client auth
});

const gelfClient = new GelfClient(secureTransport);

// Not required. gelf-client will connect automatically upon send if necessary.
await gelfClient.connect();

await gelfClient.send({
    message: 'This is my message',
    level: 2
}, {
    myPayload1: 2,
    mayPayload2: {
        userId: 1,
        sessionId: 2
    }
});

await gelfClient.disconnect();

```

## 常见问题

### @chax-at/gelf-client 是什么？

一个简单的Gelf客户端用于节点\. 目前支持TCP和TCP/TLS\.

### 如何安装 @chax-at/gelf-client？

在项目目录运行 npm install @chax-at/gelf-client，或使用 pnpm add / yarn add / bun add。

### @chax-at/gelf-client 支持 TypeScript 吗？

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

### @chax-at/gelf-client 支持 ESM 还是 CommonJS？

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

### @chax-at/gelf-client 可以商用吗？

@chax-at/gelf-client 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @chax-at/gelf-client 的下载量有多少？

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

### @chax-at/gelf-client 还在维护吗？

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