# @datalust/winston-seq 中文文档

规范地址：https://npmcn.com/package/%40datalust/winston-seq/

版本：3\.0\.1
npm 元数据更新时间：2025-05-12T01:02:32.972Z
中文译文更新时间：2026-11-11T14:46:50.819Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：18.3 kB，7 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：winston ^3\.17\.0
- 首次发布：2021-11-03T00:23:46.201Z
- 最新版本发布：2025-05-12T01:02:32.728Z
- 近 30 天下载量：267307（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 0 个）

## 中文简介

用于 Seq 的温斯顿 v3 运输

## 安装

```sh
npm install @datalust/winston-seq
```

也可以使用：`pnpm add @datalust/winston-seq`、`yarn add @datalust/winston-seq`、`bun add @datalust/winston-seq`

## README

# `winston-seq` [![npm](https://img.shields.io/npm/v/@datalust/winston-seq.svg)](https://www.npmjs.com/package/@datalust/winston-seq)

A 类 [温斯顿](https://github.com/winstonjs/winston) v3 传送结构化日志到 [Seq 日志服务器](https://datalust.co/seq)。 。 。 .

![Structured logging with Seq](https://npmcn.com/package/%40datalust/winston-seq/assets/seq-log-search-feature-2220w.gif)

## 开始

添加数据 `@datalust/winston-seq winston` 财务报告和审定财务报表 `winston` 给您的软件包 `package.json`配置 `winston` 带有 `SeqTransport`数字 :

```ts
import winston from 'winston';
import { SeqTransport } from '@datalust/winston-seq';

const logger = winston.createLogger({
  level: 'info',
  format: winston.format.combine(  /* This is required to get errors to log with stack traces. See https://github.com/winstonjs/winston/issues/1498 */
    winston.format.errors({ stack: true }),
    winston.format.json(),
  ),
  defaultMeta: { /* application: 'your-app-name' */ },
  transports: [
    new winston.transports.Console({
        format: winston.format.simple(),
    }),
    new SeqTransport({
      serverUrl: "https://your-seq-server:5341",
      apiKey: "your-api-key",
      onError: (e => { console.error(e) }),
      handleExceptions: true,
      handleRejections: true,
    })
  ]
});
```

-   `serverUrl` - 用于您 Seq 服务器摄入的 URL
-   `apiKey` - (可选) [Seq API 密钥](https://docs.datalust.co/docs/getting-logs-into-seq#api-keys) 用于
-   `onError` - 当运输中发生错误时召回执行
-   `handleExceptions` - (可选)发送事件 [当出现未发现的例外时](https://github.com/winstonjs/winston#handling-uncaught-exceptions-with-winston)
-   `handleRejections` - (可选)发送事件 [当一个无助的约言被否认的时候](https://github.com/winstonjs/winston#handling-uncaught-promise-rejections-with-winston)

## 发送日志事件

发送结构化日志事件, 其属性日后可用于过滤和分析 :

```ts
logger.info("Hello {name}", {name: "World"});
```

通过创建儿童日志附加上下文 :

```ts
const taskLogger = logger.child({ activity: "purchase" });
taskLogger.debug(
    "User {user} purchase product {product} at ${price}", 
    {
        user: "Millie Gilbert",
        product: "Yardtime Garden Shears",
        price: 29.99
    });
```

![An event in Seq](https://npmcn.com/package/%40datalust/winston-seq/assets/purchase.png)

## 常见问题

### @datalust/winston-seq 是什么？

用于 Seq 的温斯顿 v3 运输

### 如何安装 @datalust/winston-seq？

在项目目录运行 npm install @datalust/winston-seq，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：winston（^3\.17\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @datalust/winston-seq 支持 TypeScript 吗？

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

### @datalust/winston-seq 支持 ESM 还是 CommonJS？

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

### @datalust/winston-seq 可以商用吗？

@datalust/winston-seq 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @datalust/winston-seq 的下载量有多少？

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

### @datalust/winston-seq 还在维护吗？

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