Nickelback Plays Music

    @wiredcraft/miniprogram-wiredsentry

    0.4.0-dev.3 • Public • Published

    sentry-miniprogram-sdk

    Usage

    1. Install
    yarn add @wiredcraft/miniprogram-sentry
    1. instantiate the client(better do this at the beginning of the miniprogram initialization)
    import { Sentry } from './wiredsentry.es.js';
    
    // instantiate
    const sentryDSN = 'https://123456789fd4454f8e3fb4d92f6a158f@sentry.service.wiredcraft.com/5';
    const sentry = new Sentry(sentryDSN);

    Note: you should instantiate the client only once. The above DSN is just an example, different projects will have different ones. Get your one from relevant stakeholders.

    1. use it in your code

    global exception hook

    in app.js onError method

    onError(error) {
      sentry.captureException(error);
    }

    on demand report

    const err = new Error('failed to retrieve user info');
    
    sentry.captureException(err);

    Advanced Usage

    Report system and user information

    When you instantiate the client, you can 2 pass extra functions as options.

    • getSystemInfo it should return plain object about the system information, default to wx.getSystemInfoSync
    • getUserInfo it should return plain object of the user information, default to () => null - note the success callback of wx.getUserInfo return other informations like rawData, encryptedData, iv, you should pass userInfo only, see miniprogram getSystemInfo API doc here
    const sentry = new Sentry(sentryDSN, {
      getUserInfo: () => {
        return {
          nickName: 'Joe'
        }
      }
    });

    Report with extra information

    const err = new Error('failed to retrieve user info');
    
    sentry.captureException(err, {
      extra: { whatever: 'extra information goes here', lorem: 'and here' }
    });

    Build

    yarn build

    References

    Keywords

    none

    Install

    npm i @wiredcraft/miniprogram-wiredsentry

    DownloadsWeekly Downloads

    3

    Version

    0.4.0-dev.3

    License

    MIT

    Unpacked Size

    216 kB

    Total Files

    6

    Last publish

    Collaborators

    • kusmarius
    • djordjeobradovic
    • jelena10
    • kunlun8809
    • shane777
    • stellar_saber
    • xavier.lai
    • stefan1105
    • loicpirezwc
    • draganmijajilovic
    • nebojsapm
    • freeyetiw
    • raohael_biland
    • liyachun01
    • echoyueyu
    • wiredcraft-bot
    • makara
    • xavierchow
    • drakexiang
    • kaleocheng
    • flyingant
    • ccharlieli
    • rankun203
    • superbogy
    • miffyliye
    • lalawow
    • bsdelf
    • shuaibird
    • juhas
    • xiao_t
    • agreatfool
    • chopperlee2011
    • woodpig07
    • dowla
    • eronekogin
    • kuno
    • xpol
    • wangjianting
    • estemomento