# @grafana/faro-web-sdk 中文文档

规范地址：https://npmcn.com/package/%40grafana/faro-web-sdk/

版本：2\.14\.0
npm 元数据更新时间：2026-11-09T16:02:02.318Z
中文译文更新时间：2026-11-16T21:42:00.543Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：1.7 MB，453 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2022-10-31T12:07:38.939Z
- 最新版本发布：2026-11-09T16:02:01.956Z
- 近 30 天下载量：6385523（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：102（近 12 个月 26 个）

## 中文简介

法罗仪表, metas, 为网络所运输.

## 安装

```sh
npm install @grafana/faro-web-sdk
```

也可以使用：`pnpm add @grafana/faro-web-sdk`、`yarn add @grafana/faro-web-sdk`、`bun add @grafana/faro-web-sdk`

## README

# @grafana/faro-web-sdk (英语)

Faro是一个SDK,它可以仪器前端JavaScript应用程序来收集遥测并转发到 [格拉法纳合金](https://grafana.com/docs/alloy/latest/) (应用代理接收器集成启用).

格拉法纳 合金可以发送此数据到任何一种 [罗基](https://grafana.com/logs/) 或者说 [临时](https://grafana.com/traces/)。 。 。 .

## 开始吧

见 [快速启动网络应用程序](https://github.com/grafana/faro-web-sdk/blob/main/docs/sources/tutorials/quick-start-browser.md)。 。 。 .

或者,您可以使用库的CDN版本. 见 [使用 cdn 库](https://github.com/grafana/faro-web-sdk/blob/main/docs/sources/tutorials/use-cdn-library.md) 详细介绍如何这样做.

## 仪器

-   控制台 - 捕获已登录到的信件 `console` 全球对象。 仅 `warn`, (中文(简体) ), `info` 财务报告和审定财务报表 `error` 默认水平.
-   错误 - 抓取未处理的顶级例外
-   网络活性 -- -- 获取网络活性指标
-   会话 - 发送会话启动事件
-   视图 - 发送已更改的视图事件
-   导航 - 捕捉软导航并报告其URL变化和持续时间
-   挫折感 - 为每次愤怒点击、死亡点击和错误点击发送事件,但不为普通点击发送事件

默认启用导航仪表 。 要禁用,请通过 `trackNavigation: false` 改为 `getWebInstrumentations()` 提供自定义仪器时,或提供自定义 `instrumentations` 没有阵列 `NavigationInstrumentation`。 。 。 .

## 元数据

-   浏览器 - 抓取浏览器元数据:名称,版本等
-   os - 从用户代理中获取 OS 名称和版本解析
-   页面 - 抓取当前 URL
-   视图 - 网络 SDK 执行 a `default` 视图元值a

## 运输

-   控制台 - 日志事件到全局 `console`
-   获取 - 从 HTTP 发送事件到后端

## 示例

基本设置, 将自动报告错误和网络动态 :

```ts
import { initializeFaro } from '@grafana/faro-web-sdk';

const faro = initializeFaro({
  url: 'https://agent.myapp/collect',
  apiKey: 'secret',
  app: {
    name: 'frontend',
    version: '1.0.0',
  },
});

// send a log message
faro.api.pushLog(['hello world']);

// will be captured
throw new Error('oh no');

// push error manually
faro.api.pushError(new Error('oh no'));
```

通过OTel追踪和浏览器控制台抓取:

```ts
import { ConsoleInstrumentation, getWebInstrumentations, initializeFaro } from '@grafana/faro-web-sdk';
import { TracingInstrumentation } from '@grafana/faro-web-tracing';

const faro = initializeFaro({
  url: 'https://agent.myapp/collect',
  apiKey: 'secret',
  instrumentations: [...getWebInstrumentations({ captureConsole: true }), new TracingInstrumentation()],
  app: {
    name: 'frontend',
    version: '1.0.0',
  },
});

// start a span
faro.api
  .getOTEL()
  ?.trace.getTracer('frontend')
  .startActiveSpan('hello world', (span) => {
    // send a log message
    faro.api.pushLog(['hello world']);
    span.end();
  });

// will be captured
throw new Error('oh no');
```

## 常见问题

### @grafana/faro-web-sdk 是什么？

法罗仪表, metas, 为网络所运输\.

### 如何安装 @grafana/faro-web-sdk？

在项目目录运行 npm install @grafana/faro-web-sdk，或使用 pnpm add / yarn add / bun add。

### @grafana/faro-web-sdk 支持 TypeScript 吗？

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

### @grafana/faro-web-sdk 支持 ESM 还是 CommonJS？

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

### @grafana/faro-web-sdk 可以商用吗？

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

### @grafana/faro-web-sdk 的下载量有多少？

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

### @grafana/faro-web-sdk 还在维护吗？

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

