https://github.com/tmkx/wx-sentry

Sentry SDK for WeChat MiniApp
https://github.com/tmkx/wx-sentry

miniapp sentry sentry-sdk weapp wechat-mini-program xiaochengxu

Last synced: about 1 year ago
JSON representation

Sentry SDK for WeChat MiniApp

• Host: GitHub
• URL: https://github.com/tmkx/wx-sentry
• Owner: tmkx
• License: bsd-3-clause
• Created: 2020-10-20T09:01:37.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2020-12-23T11:56:12.000Z (over 5 years ago)
• Last Synced: 2025-02-06T11:18:52.050Z (over 1 year ago)
• Topics: miniapp, sentry, sentry-sdk, weapp, wechat-mini-program, xiaochengxu
• Language: TypeScript
• Homepage:
• Size: 319 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


  

    

  

  




# Sentry SDK for WeChat MiniApp

Sentry SDK 微信小程序版，基于官方 SDK 5.27.1 版修改

## 链接

- [官方 SDK 文档](https://docs.sentry.io/platforms/javascript/)

## 使用方式

请在小程序初始化后尽早调用`Sentry.init(options)`。这将初始化 SDK 并注入到小程序环境中。你可以使用相应的选项关闭几乎所有的副作用。

```javascript

import * as Sentry from 'wx-sentry';

Sentry.init({

  dsn: '__DSN__',

  // ...

});

```

要设置上下文信息或发送手动事件，请使用`wx-sentry`导出的函数。注意，这些在调用`Sentry.init()`之前，函数不会执行任何操作:

```javascript

import * as Sentry from 'wx-sentry';

// Set user information, as well as tags and further extras

Sentry.configureScope((scope) => {

  scope.setExtra('battery', 0.7);

  scope.setTag('user_mode', 'admin');

  scope.setUser({ id: '4711' });

  // scope.clear();

});

// Add a breadcrumb for future events

Sentry.addBreadcrumb({

  message: 'My Breadcrumb',

  // ...

});

// Capture exceptions, messages or manual events

Sentry.captureMessage('Hello, world!');

Sentry.captureException(new Error('Good bye'));

Sentry.captureEvent({

  message: 'Manual',

  stacktrace: [

    // ...

  ],

});

```