# @gravity-ui/ui-logger 中文文档

规范地址：https://npmcn.com/package/%40gravity-ui/ui-logger/

版本：1\.1\.0
npm 元数据更新时间：2023-02-02T09:06:55.760Z
中文译文更新时间：2026-11-17T01:14:00.011Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：26.9 kB，24 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2023-02-02T09:06:55.302Z
- 最新版本发布：2023-02-02T09:06:55.526Z
- 近 30 天下载量：11338（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 0 个）

## 中文简介

UI 日志

## 安装

```sh
npm install @gravity-ui/ui-logger
```

也可以使用：`pnpm add @gravity-ui/ui-logger`、`yarn add @gravity-ui/ui-logger`、`bun add @gravity-ui/ui-logger`

## README

# UI 日志

## 使用量

```bash
npm i @gravity-ui/ui-logger
```

```ts
import logger from '@gravity-ui/ui-logger';

try {
  // logger.log(message: string, extraData?: Record<string, unknown>);
  logger.log('Info event', {extraInfo: 'Extra data'});
} catch (error) {
  // logger.logError(message: string, error?: Error, extraData?: Record<string, unknown>);
  logger.logError('Error event', error, {extraError: 'Extra data'});
}

// get all recorded logs
const logs = logger.getLogs();
```

## 已命名的日志

默认情况下,日志会被写入 `namespace` 名称 `default`。 。 。 .

创建自己的 `namespace`数字 :

-   一个大应用程序的逻辑分割日志 .
-   某些错误需要自定义 [错误分析器](https://npmcn.com/package/%40gravity-ui/ui-logger/#readme-settings)。 。 。 .

```ts
import logger from '@gravity-ui/ui-logger';

// Returns or creates a new logger instance with the name my_namespace
const namedLogger = logger.get('my_namespace');
namedLogger.log('Will record to scope my_namespace');

const anotherOneLogger = namedLogger.get('another_one');
namedLogger.log('Will record to scope another_one');
```

## 设置

设置既可以是所有日志的全局,也可以是特定日志的局部.

```ts
import logger from '@gravity-ui/ui-logger';

type DefaultSettings = {
  // The number of log records for each namespace. By default, 1000.
  bufferSize: number;
  // Function for error parsing in logError.
  parseError: (error: Error) => Record<string, unknown>;
  // Print log, logError to the console. By default, true.
  printLog: boolean;
  // Callback function that is called every time logError is called with the same arguments as logError
  logErrorCallback: ((message: string, error?: Error, data?: ExtraData) => void) | null;
};

// will change the number of records for all loggers
logger.setDefault({bufferSize: 200});

type LoggerSettings = {
  bufferSize: number;
  parseError: (error: Error) => Record<string, unknown>;
  logErrorCallback: ((message: string, error?: Error, data?: ExtraData) => void) | null;
};

const namedLogger = logger.get('name');
function namedParseError(error: Error) {
  return {message: error.message, meta: {}};
}

// will change ParseError only for logger `name`
namedLogger.setSettings({parseError: namedParseError});
```

## 常见问题

### @gravity-ui/ui-logger 是什么？

UI 日志

### 如何安装 @gravity-ui/ui-logger？

在项目目录运行 npm install @gravity-ui/ui-logger，或使用 pnpm add / yarn add / bun add。

### @gravity-ui/ui-logger 支持 TypeScript 吗？

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

### @gravity-ui/ui-logger 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @gravity-ui/ui-logger 可以商用吗？

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

### @gravity-ui/ui-logger 的下载量有多少？

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

### @gravity-ui/ui-logger 还在维护吗？

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

