https://github.com/youzan/raven-weapp
Sentry SDK for WeApp
https://github.com/youzan/raven-weapp
crash-reporting error-handling javascript javascript-library raven sentry sentry-service weapp
Last synced: about 1 year ago
JSON representation
Sentry SDK for WeApp
- Host: GitHub
- URL: https://github.com/youzan/raven-weapp
- Owner: youzan
- Created: 2017-09-21T06:29:33.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-10-01T03:28:20.000Z (over 6 years ago)
- Last Synced: 2024-02-25T15:41:14.153Z (about 2 years ago)
- Topics: crash-reporting, error-handling, javascript, javascript-library, raven, sentry, sentry-service, weapp
- Language: JavaScript
- Homepage:
- Size: 158 KB
- Stars: 159
- Watchers: 14
- Forks: 51
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Raven-weapp
为方便小程序接入sentry，由raven改写而来的小程序版本。
#### 引入文件
由于目前小程序不支持从node_modules中引入文件，因此以npm方式安装的话只能手动将raven-weapp/dist目录下需要的文件拷贝到其他文件中，在app.js中引入，例如：
```
var Raven = require('./utils/raven-weapp/build/raven')
```
或以Bower安装raven-weapp并引入：
```
var Raven = require('./bower_components/raven-weapp/build/raven')
```
#### 初始化Raven
```
Raven.config('https://xxx@crash.youzan.com/x', options).install()
```
在app的onLaunch中初始化(?)，options为可选配置对象，目前支持：
```
options = {
release: '当前小程序版本'，
environment: '指定为production才会上报',
allowDuplicates: true, // 允许相同错误重复上报
sampleRate: 0.5 // 采样率
}
```
#### 收集信息
收集的信息将在上报时被一起带上
##### 基本信息
初始化后raven会默认收集以下信息：
```
{
SDKversion: '小程序基础库版本',
WXversion: '微信版本',
device: '设备型号',
network: '网络类型',
system: '系统信息',
}
```
可以通过[Raven.setUserContext(context)](https://docs.sentry.io/learn/context/#capturing-the-user)或者[Raven.setExtraContext(context)](https://docs.sentry.io/learn/context/#extra-context)添加更多信息（kdtId和userId等）
##### 用户行为
###### console
console的行为默认将被自动收集
###### ajax
wx.request不可扩展，因此只能手动收集请求的行为：例如在经过封装的请求函数的成功回调内添加：
```
Raven.captureBreadcrumb({
category: 'ajax',
data: {
method: 'get',
url: 'weapp.showcase.page/1.0.0/get',
status_code: 200
}
```
###### dom
ui操作的记录暂不支持
###### location
页面变化的记录暂不支持
#### 信息上报
分为message和exception的上报
##### message
使用[Raven.captureMessage(msg, option)](https://docs.sentry.io/clients/javascript/usage/#capturing-messages)上报需要上报的信息比如ajax的报错等
##### exception
所有uncaught exception都会被小程序捕获封装成msg传递到app的onError中，在onError中上报这些信息：
```
onError(msg) {
Raven.captureException(msg, {
level: 'error'
})
}
```