@gravity-ui/ui-logger

中文文档
1.1.0发布于 2023/02/02MITTypeScriptESM + CJS零依赖近 30 天下载 1.1万

UI logger

原始使用文档
文档目录3 节
  1. Usage
  2. Named loggers
  3. Settings

UI logger

Usage

npm i @gravity-ui/ui-logger
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();

Named loggers

By default, logs are written to namespace with the name default.

Possible reasons to create your own namespace:

  • Logically split logs of a large application.
  • For certain errors, you need a custom error parser.
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');

Settings

The settings can be either global for all loggers or local for a specific logger.

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 共发布 1 个版本,首次发布于 2023/02/02;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.1.0latest2023/02/023 年前

关于 @gravity-ui/ui-logger 的常见问题

@gravity-ui/ui-logger 是什么?

UI logger

如何安装 @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 和提交记录判断。