@heimdallr-sdk/browser
TypeScript icon, indicating that this package has built-in type declarations

0.0.29 • Public • Published

@heimdallr-sdk/browser

English

浏览器监控基座,内置错误捕获sdk

可捕获错误类型

  • js错误
  • 资源加载错误
  • unhandledrejection

默认使用 sendBeaconAPI (post)上报

Options

配置名称 类型 描述 可选值 默认值
dsn Object 上报接口配置信息 DSN -
app Object 应用信息 APPInfo -
enabled Boolean 是否向后台发送事件 true/false true
maxBreadcrumbs Number 面包屑最大层级 - 5
userIdentify Customer 用户标识 - -
plugins Array 插件集合 - -
debug Boolean 控制台是否显示sdk输出信息 true/false false

DSN

名称 类型 描述 可选值
host String 上报接口域名地址 -
init String 应用初始化接口地址 -
upload String 信息上报接口地址 -

APPInfo

名称 类型 描述 可选值
name String 应用名称 -
leader String 负责人 -
desc String 应用描述 -

Customer

名称 类型 描述 可选值
name string 业务字段名称(支持点运算符读取,cookie除外) -
postion string 存储位置 local/session/cookie/global

Usage

cdn

<script>
    window.__HEIMDALLR_OPTIONS__ = {
        dsn: {
            host: 'localhost:8888',
            init: '/project/init',
            upload: '/log/upload'
        },
        app: {
            name: 'playgroundAPP',
            leader: 'test',
            desc: 'test proj'
        },
        userIdentify: {
            name: '__state__.a.0.user.id', // window.__state__ = { a: [{ user: { id:'123' } }] }
            position: 'global'
        }
    };
</script>
<script async src="/browser-dist/browser.iife.js"></script>

npm

import heimdallr from "@heimdallr-sdk/browser";
heimdallr({
    dsn: {
        host: 'localhost:8888',
        init: '/project/init',
        upload: '/log/upload'
    },
    app: {
        name: 'playgroundAPP',
        leader: 'test',
        desc: 'test proj'
    },
    userIdentify: {
        name: '__state__.a.0.user.id', // window.__state__ = { a: [{ user: { id:'123' } }] }
        position: 'global'
    }
});

Package Sidebar

Install

npm i @heimdallr-sdk/browser

Weekly Downloads

4

Version

0.0.29

License

MIT

Unpacked Size

65.2 kB

Total Files

17

Last publish

Collaborators

  • h_lianfa