HEIMDALLR-SDK

Appearance

On this page

@heimdallr-sdk/browser ​

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

可捕获错误类型

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

默认使用 sendBeaconAPI （post）上报

Options ​

配置名称类型描述可选值默认值
dsnObject上报接口配置信息DSN-
appObject应用信息APPInfo-
enabledBoolean是否向后台发送事件true/falsetrue
maxBreadcrumbsNumber面包屑最大层级-5
userIdentifyCustomer用户标识--
pluginsArray插件集合--
debugBoolean控制台是否显示sdk输出信息true/falsefalse

DSN ​

名称类型描述可选值
hostString上报接口域名地址-
initString应用初始化接口地址-
uploadString信息上报接口地址-

APPInfo ​

名称类型描述可选值
nameString应用名称-
leaderString负责人-
descString应用描述-

Customer ​

名称类型描述可选值
namestring业务字段名称（支持点运算符读取，cookie除外）-
postionstring存储位置local/session/cookie/global

Usage ​

cdn ​

html
<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 ​

js
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'
    }
});