# @blyp/core 中文文档

规范地址：https://npmcn.com/package/%40blyp/core/

版本：0\.1\.36
npm 元数据更新时间：2026-10-23T09:05:56.401Z
中文译文更新时间：2026-11-08T09:14:01.359Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：7.4 MB，336 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：5 个
- peer 依赖：ai ^6 \|\| ^7，eve ~0\.80\.1，hono ^4，next ^15 \|\| ^16，nuxt ^4，rxjs ^7，astro ^6，agents ~0\.30\.0，convex \>=1\.39\.0，elysia ^1\.4\.27，express ^5，fastify ^5，nitropack ^2，typescript ^5，better-auth ^1\.6\.5，drizzle-orm ^0\.36 \|\| ^0\.37 \|\| ^0\.38 \|\| ^0\.39 \|\| ^0\.40，@nestjs/core ^10 \|\| ^11，@sentry/node ^10，posthog-node ^5，react-router ^7，@farm\.js/core \>=0\.1\.0-beta\.40 \<0\.2\.0，@logtail/node ^0\.5，@sveltejs/kit ^2，@clerk/backend ^2，@databuddy/sdk ^2，@nestjs/common ^10 \|\| ^11，@prisma/client ^5 \|\| ^6，@solidjs/start ^1，@workos-inc/node ^7，@aws-sdk/client-s3 ^3\.1155\.0，@better-agent/core ^0\.1\.0-beta\.1，@opentelemetry/api ^1，@opentelemetry/core ^2，@tanstack/react-start ^1，@newrelic/browser-agent ^1，@opentelemetry/api-logs ^0\.206，@opentelemetry/sdk-logs ^0\.206，@nestjs/platform-express ^10 \|\| ^11，@nestjs/platform-fastify ^10 \|\| ^11，@opentelemetry/resources ^2，@opentelemetry/sdk-metrics ^2，newrelic-react-native-agent ^1，@opentelemetry/sdk-trace-base ^2，@opentelemetry/sdk-trace-node ^2，@opentelemetry/otlp-transformer 0\.206\.0，@opentelemetry/context-async-hooks ^2，@opentelemetry/exporter-logs-otlp-http ^0\.206，@opentelemetry/exporter-logs-otlp-proto ^0\.206，@opentelemetry/exporter-trace-otlp-proto ^0\.206，@opentelemetry/exporter-metrics-otlp-proto ^0\.206
- 首次发布：2026-03-16T22:22:21.825Z
- 最新版本发布：2026-10-23T09:05:55.710Z
- 近 30 天下载量：1931（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 15 个）

## 中文简介

一个具有 Bun-First 运行时间检测和 TypeScript 支持的高性能,模块化的日志器. 建于皮诺上,并支援了爱丽西亚,浩诺,快通,快通,雀巢JS,Next.js App路由器,Farm.js,React路由器,Astro,Nitro,Nuxt,TanStack Start,SolidStart,和S

## 安装

```sh
npm install @blyp/core
```

也可以使用：`pnpm add @blyp/core`、`yarn add @blyp/core`、`bun add @blyp/core`

## README

# 布莱普·洛格

**布莱普** 是一个独立的应用程序和现代网络框架的 TypeScript 日志 . 它给你结构化的日志,框架适配器,客户端对服务器日志摄取,以及可选的连接器,而不将根的README变成完整的手册.

[![Bun](https://img.shields.io/badge/Bun-1.2+-000000?style=flat&logo=bun)](https://bun.sh/) [![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-3178C6?style=flat&logo=typescript)](https://www.typescriptlang.org/) [![Elysia](https://img.shields.io/badge/Elysia-1.4+-00D8FF?style=flat)](https://elysiajs.com/)

## 要点

-   在独立的应用程序中或与框架适配器一起使用.
-   使用 `createStructuredLog`。 。 。 .
-   在日志到达输出或下游汇之前修改共同的秘密.
-   从浏览器和博览会的应用程序进入您的后端流的浏览日志 .
-   将日志转发给可选的连接器,如"新遗物","后霍格","更好的堆栈","哨兵","Databuddy",命名为"HTTP端点","OTLP"等目标.
-   为 Bun- first 设置所建,支持支持的节点运行时间 .
-   完整 TypeScript 支持整个主包和子路径导出.

## 安装

```bash
bun add @blyp/core
```

`npm install @blyp/core` | `pnpm add @blyp/core` | `yarn add @blyp/core`

如果您使用 Expo 日志, 请同时安装 `expo-network`。 。 。 .

```bash
npx expo install expo-network
```

## 快开始

```ts
import { logger } from '@blyp/core';

logger.info('Server started', { port: 3000 });
logger.success('Connected to database');
logger.error('Payment failed', { orderId: 'ord_123' });
```

## 结构化日志

```ts
import { createStructuredLog } from '@blyp/core';

const log = createStructuredLog('checkout', {
  service: 'web-api',
  level: 'info',
  timestamp: new Date().toISOString(),
});

log.set({
  user: { id: 1, plan: 'pro' },
  cart: { items: 3, total: 9999 },
});

log.info('checkout started');
log.emit({ status: 200 });
```

内部框架处理器, `createStructuredLog(...)` 自动绑定在活动请求日志中 。 最终结构化记录在调用时被写入 `.emit()`。 。 。 .

## 框架实例

Blyp支持Elysia,Hono,快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活快活活快活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活活.

```ts
import { Elysia } from 'elysia';
import { createLogger } from '@blyp/core/elysia';

const app = new Elysia()
  .use(createLogger({ level: 'info', autoLogging: true }))
  .get('/', () => 'Hello World')
  .listen(3000);
```

见 [框架集成文件](https://npmcn.com/package/%40blyp/core/docs/README.md#framework-integrations) 用于完整的适配器矩阵和特定框架实例.

### 农场.js

```ts
// farm.config.ts
import { defineConfig } from '@farm.js/core';
import { blypPlugin } from '@blyp/core/farmjs';

export default defineConfig({
  plugins: [blypPlugin()],
});
```

```ts
// src/app/api/products/route.ts
import { logger } from '@blyp/core/farmjs';

export async function GET() {
  logger.info('loaded products');
  return Response.json({ ok: true });
}
```

该插件会自动记录请求,出错,选定的Farm生命周期事件,浏览器导航和性能遥测,浏览器出错等. 它目前支持Farm的节点和Bun服务器运行时间.

## 更好的认证

更好的Auth可以作为真正的Better Auth插件被附加,然后被Blip框架适配器再用来请求浓缩.

```ts
import { betterAuth } from 'better-auth';
import { blyp } from '@blyp/core/better-auth';

export const auth = betterAuth({
  plugins: [
    blyp({
      clientLogging: true,
    }),
  ],
});
```

```ts
import { createLogger } from '@blyp/core/nextjs';
import { auth } from './auth';

export const nextLogger = createLogger({
  auth: {
    betterAuth: auth,
  },
});
```

```ts
import { createAuthClient } from 'better-auth/client';
import { blypClient } from '@blyp/core/better-auth';

export const authClient = createAuthClient({
  plugins: [blypClient()],
});

const logger = authClient.blyp.createLogger();
logger.info('mounted');
```

## 办事员

办事员通过布莱普共享的服务器认证配置而不是插件进行集成. Blyp 用 `@clerk/backend`,使每个服务器日志记录上的认证状态正常化,并在客户端登录者将浏览器日志身份发布到 Blip 端点时从服务器上获取 `/blyp/log`。 。 。 .

```ts
import { clerk, createClerkClientLogger } from '@blyp/core/clerk';
import { createLogger } from '@blyp/core/nextjs';

export const nextLogger = createLogger({
  auth: {
    clerk: clerk({
      secretKey: process.env.CLERK_SECRET_KEY!,
      publishableKey: process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY!,
      jwtKey: process.env.CLERK_JWT_KEY,
      authorizedParties: ['https://app.example.com'],
    }),
  },
  clientLogging: {
    path: '/blyp/log',
  },
});

export const clientLogger = createClerkClientLogger({
  endpoint: '/blyp/log',
});
```

见 [全员集成文件](https://npmcn.com/package/%40blyp/core/docs/README.md#clerk-auth) 用于 Next.js, Express, React Router, 以及机器认证的示例.

## 更多特性

-   [自动编辑](https://npmcn.com/package/%40blyp/core/docs/README.md#automatic-redaction) 对于共同的秘密,信头,和风俗模式.
-   [客户和博览会记录](https://npmcn.com/package/%40blyp/core/docs/README.md#client) 用于浏览器和通过后端发送日志的移动应用程序.
-   [AI 追踪](https://npmcn.com/package/%40blyp/core/docs/README.md#ai-sdk-tracing) 对于Vercel AI SDK,更好的代理, [夏娃探员](https://npmcn.com/package/%40blyp/core/docs/README.md#eve-agent-tracing), (中文(简体) ), [云雾剂事件](https://npmcn.com/package/%40blyp/core/docs/README.md#cloudflare-agents-events),OpenAI,Anthropic,以及相容的运输.
-   [数据库记录](https://npmcn.com/package/%40blyp/core/docs/README.md#database-logging) 当文件持久性不适合时.
-   连接器转发 [新遗迹](https://npmcn.com/package/%40blyp/core/docs/README.md#new-relic-connector), (中文(简体) ), [邮箱](https://npmcn.com/package/%40blyp/core/docs/README.md#posthog-connector), (中文(简体) ), [数据掩体](https://npmcn.com/package/%40blyp/core/docs/README.md#databuddy-connector), (中文(简体) ), [更好的堆叠](https://npmcn.com/package/%40blyp/core/docs/README.md#better-stack-connector), (中文(简体) ), [哨兵](https://npmcn.com/package/%40blyp/core/docs/README.md#sentry-connector), (中文(简体) ), [HTTP 密码](https://npmcn.com/package/%40blyp/core/docs/README.md#http-connector),以及 [OTLP 输油管](https://npmcn.com/package/%40blyp/core/docs/README.md#otlp-connector)。 。 。 .

## 文档

-   [完整文档](https://npmcn.com/package/%40blyp/core/docs/README.md)
-   [框架整合](https://npmcn.com/package/%40blyp/core/docs/README.md#framework-integrations)
-   [客户和博览会记录](https://npmcn.com/package/%40blyp/core/docs/README.md#client)
-   [AI 追踪](https://npmcn.com/package/%40blyp/core/docs/README.md#ai-sdk-tracing)
-   [数据库记录](https://npmcn.com/package/%40blyp/core/docs/README.md#database-logging)
-   [后连接器](https://npmcn.com/package/%40blyp/core/docs/README.md#posthog-connector)
-   [数据块连接器](https://npmcn.com/package/%40blyp/core/docs/README.md#databuddy-connector)
-   [更好的堆栈连接器](https://npmcn.com/package/%40blyp/core/docs/README.md#better-stack-connector)
-   [哨兵连接器](https://npmcn.com/package/%40blyp/core/docs/README.md#sentry-connector)
-   [HTTP 连接器](https://npmcn.com/package/%40blyp/core/docs/README.md#http-connector)
-   [新的遗迹日志、遥测、浏览器/移动监控和账户 API](https://npmcn.com/package/%40blyp/core/docs/connectors/newrelic.md)
-   [OTLP 连接器](https://npmcn.com/package/%40blyp/core/docs/README.md#otlp-connector)
-   [稳定政策](https://npmcn.com/package/%40blyp/core/STABILITY.md)
-   [安全政策](https://npmcn.com/package/%40blyp/core/SECURITY.md)
-   [捐款](https://npmcn.com/package/%40blyp/core/CONTRIBUTING.md)
-   [测试文件](https://npmcn.com/package/%40blyp/core/tests/README.md)

## 发展

```bash
bun install
bun run test
bun run build
bun run type-check
```

## 许可证

麻省理工学院

## 无存储摄入量

使用 `destination: 'none'` 来通过启用的连接器或OTLP转发日志,而无需本地日志文件、数据库存储或磁盘队列。 需要至少一个已配置的连接器,摄入的客户端日志必须选择一个已准备好的目标. 见 [配置和客户端示例](https://npmcn.com/package/%40blyp/core/docs/README.md#storageless-ingestion)。 。 。 .

## 操作连接器可靠性

见 [霍格后/哨兵合同](https://npmcn.com/package/%40blyp/core/docs/connectors/contracts.md), (中文(简体) ), [公布的一揽子调查](https://npmcn.com/package/%40blyp/core/docs/connectors/investigation.md),以及 [CarsXE 迁移实例](https://npmcn.com/package/%40blyp/core/docs/connectors/carsxe-migration.md) 用于结构化错误,核实身份,最后的负载隐私,有界限的冲洗和无持久性操作. 运行 `npm run test:packed-connectors` 在孤立的Node CommunityJS/ESM应用程序中验证装有真实SDK的打包包.

## S3 存储

设定 `destination: 's3'` 在 AWS S3 、 Cloudflare R2 或 MinIO 中存储压缩日志批次,并在 Studio 中浏览,并明确允许阅读。 内存缓冲是默认的;持久的SQLite spolling是可选的. 见 [S3 存储和工作室](https://npmcn.com/package/%40blyp/core/docs/connectors/s3.md) 用于配置、权限、恢复和提供者验证状态.

## 常见问题

### @blyp/core 是什么？

一个具有 Bun-First 运行时间检测和 TypeScript 支持的高性能,模块化的日志器\. 建于皮诺上,并支援了爱丽西亚,浩诺,快通,快通,雀巢JS,Next\.js App路由器,Farm\.js,React路由器,Astro,Nitro,Nuxt,TanStack Start,SolidStart,和S

### 如何安装 @blyp/core？

在项目目录运行 npm install @blyp/core，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：typescript（^5）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @blyp/core 支持 TypeScript 吗？

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

### @blyp/core 支持 ESM 还是 CommonJS？

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

### @blyp/core 可以商用吗？

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

### @blyp/core 的下载量有多少？

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

### @blyp/core 还在维护吗？

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