@baselime/react-rum

中文文档
0.3.1发布于 2024/09/09MITTypeScriptES Module近 30 天下载 2.8万

优化您反应应用程序的真实世界性能

中文使用文档
文档目录10 节
  1. 使用量
  2. 网络维度
  3. 抓取错误
  4. 边界
  5. 捕获例外
  6. 自定义事件
  7. 设置活动的用户
  8. 使用您的数据
  9. 道具
  10. 许可证

Baselime 反应真实用户监视

Documentation Latest Release License

巴塞尔 使下一代云应用具有可观察性.

此库允许您监视您的 React 和 Next.js 应用程序的真实用户行为 .

使用量

npm i --save @baselime/react-rum

添加数据 BaselimeRum 组件位于您的 React 应用程序的根 .

拿着 publicApiKey 从巴塞利姆控制台。 确保使用公用API密钥.


function Page({ child }) {

return (
    <BaselimeRum apiKey={publicApiKey}>
        {child}
    </BaselimeRum>)
}

您的应用程序的每个页面视图自动抓取以下数据:

  • timezone
  • language
  • os
  • userAgent
  • url
  • device
  • country
  • city

网络维度

此外,你可以启用捕获 网络元件 从您的反应应用程序。 使用 enableWebVitals 道具 (英语).

在您的应用程序上加载此内容, 以避免重新发送网络重要数据 .

import { BaselimeRum } from '@baselime/react-rum';

function Page({ child }) {

return (
    <BaselimeRum apiKey={publicApiKey} enableWebVitals>
        {child}
    </BaselimeRum>)
}

抓取错误

BaselimeRum 自动捕获并发送应用程序中任何未处理的错误到 Baselime.

import { BaselimeRum } from '@baselime/react-rum';

function Page({ child }) {

return (
    <BaselimeRum apiKey={publicApiKey} enableWebVitals fallback={<div>Something went wrong</div>}>
        {child}
    </BaselimeRum>)
}

边界

为终端用户提供更好的 UX , 请使用 React 边界。 。 。 .

BaseimeErrorBonborary捕获其任何子组件的错误,向Baseime报告错误. 它与 <BaselimeRum /> 组件使所有出错都与页面加载和用户会话相关.

import { BaselimeErrorBoundary } from '@baselime/react-rum';

function UserProfile({ child }) {

return (<BaselimeErrorBoundary fallback={<div>Could not display your user profile</div>}>
            <UserProfileImage />
            <UserName />
            <UserBiography />
        </BaselimeErrorBoundary>
    )
}

这是基于优秀的 反应 - 过度边界 项目.

捕获例外

边界不抓取 事件处理器内部出错。以抓住例外

import { useBaselimeRum } from '@baselime/react-rum';

function MyButtonComponent() {
    const { captureException } = useBaselimeRum();

    function handleClick(e) {
        try { 
                 // Do something that could throw  
        } catch (error) {
            // sends errors to Baselime so they can be fixed   
            captureException(error)
       }
    }

    return <button onClick={handleClick}>Click Me</button>
}

自定义事件

抓取自定义事件用于分析和监测. 像木头,但拥有一切的 贝西米.

sendEvent(message: string, payload)

import { useBaselimeRum } from '@baselime/react-rum';

function CheckoutComponent() {
    const { sendEvent } = useBaselimeRum();

    function handleClick() {

        const checkoutSession = await createImaginaryCheckoutSession()
        sendEvent("Checkout Started", {
            ...checkoutSession
        })
    }

    return <button onClick={handleClick}>Checkout</button>
}


设置活动的用户

从另一个组件设置用户然后调用

import { useBaselimeRum } from '@baselime/react-rum';

function UserCard({ child }) {
    const { setUser } = useBaselimeRum();

    function login(user) {

        setUser(user.id);
    }
    return (
        <Button onClick={login}>Login</Button>
    }

使用您的数据

获取数据后,您可在 巴塞尔控制台。您可以根据真实用户监测指标创建仪表板和提示.

道具

参数说明
apiKey您用于认证和授权的 Baselime API 密钥 .
enableWebVitals(可选)布尔旗,表示是否允许跟踪网络生命特征.
enableLocal(可选)布尔旗表示是否启用本地跟踪.
dataset(备选) 用于存储数据的数据集 。 默认为 web。 。 。 .
service正在监测申请名称。 默认主机名 .
fallback程序崩溃时倒置的 UI 组件

许可证

2023年巴塞尔美有限公司

根据麻省理工学院许可证分发The MIT License) (中文(简体) ).

见 自由主义 更多信息.

版本与发布记录

@baselime/react-rum 共发布 21 个版本,首次发布于 2023/09/22;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.3.1latest2024/09/092 年前
0.3.02024/09/092 年前
0.2.92024/04/142 年前
0.2.82024/02/272 年前
0.2.72023/12/222 年前
0.2.62023/12/112 年前

关于 @baselime/react-rum 的常见问题

@baselime/react-rum 是什么?

优化您反应应用程序的真实世界性能

如何安装 @baselime/react-rum?

在项目目录运行 npm install @baselime/react-rum,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^18.2.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@baselime/react-rum 支持 TypeScript 吗?

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

@baselime/react-rum 支持 ESM 还是 CommonJS?

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

@baselime/react-rum 可以商用吗?

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

@baselime/react-rum 的下载量有多少?

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

@baselime/react-rum 还在维护吗?

最新版本 0.3.1 发布于 2024/09/09(2 年前);至今共发布 21 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/09/22。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。