Skip to content

Commit b4100f9

Browse files
yacentYacent
yacent
authored andcommitted
doc: 更新现网错误日志上报与排查
1 parent 8c0b8c0 commit b4100f9

File tree

3 files changed

+23
-21
lines changed

3 files changed

+23
-21
lines changed

Design/IssueForProduction.md

+23-21
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,52 @@
11
# 现网错误日志上报与排查
22

33
当游戏发布到现网时,开发者需要收集玩家遇到的错误、异常等问题并进行排查原因,本文阐述在微信小游戏环境的最佳实践。
4-
开发者可通过三种途径收集到游戏异常数据:
4+
5+
开发者可通过如下三种途径收集到游戏异常数据:
56
- 用户反馈日志
67
- 小游戏实时日志
78
- JS Error错误日志
89

910
## 用户反馈日志
10-
数据入口:MP平台-用户反馈
11+
12+
> 数据入口:[MP平台](https://mp.weixin.qq.com)-用户反馈
1113
1214
当玩家游戏中出现问题时,进行功能反馈将会提交“用户反馈日志“,开发者可以在后台下载到对应数据:
1315
<img src='../image/issueforproduction1.png' width="800"/>
1416
<img src='../image/issueforproduction2.png' width="800"/>
1517

1618
该功能需要两个必要条件:
1719
1. 玩家提交反馈
18-
- 默认情况下,玩家可通过游戏右上方"..."-反馈与投诉-功能异常打开反馈入口
20+
- 默认情况下,玩家可通过游戏右上方 "...-反馈与投诉-功能异常" 打开反馈入口
1921
- 除此外,开发者也可通过使用[wx.createFeedbackButton](https://developers.weixin.qq.com/minigame/dev/api/open-api/feedback/wx.createFeedbackButton.html)主动创建反馈入口。
2022

2123
2. 开发者埋点打印日志
22-
- 默认情况下,适配插件将自动埋点游戏启动与特殊异常日志
24+
- 默认情况下,适配插件将**自动**埋点游戏启动与特殊异常日志
2325
- 除此外,开发者看通过C# SDK的LogManagerxxx系列函数进行埋点上报
24-
建议:
25-
开发者埋点上报购买物品、打开广告、进入关卡等关键信息
26-
开发者埋点上报异常捕捉的信息
2726

28-
## 小游戏实时日志
29-
数据入口:MP平台-开发管理-实时日志
27+
**建议:**
3028

31-
[实时日志](https://developers.weixin.qq.com/miniprogram/dev/framework/realtimelog/)为帮助小程序开发者快捷地排查小程序漏洞、定位问题.
29+
- 开发者埋点上报购买物品、打开广告、进入关卡等关键信息
30+
- 开发者埋点上报异常捕捉的信息
31+
32+
## 游戏实时日志
33+
34+
> 数据入口:[MP平台](https://mp.weixin.qq.com)-基础数据-游戏日志分析
35+
36+
为帮助开发者更便捷地定位问题,从基础库 `3.7.4` 开始,我们推出了[小游戏实时日志分析功能](https://developers.weixin.qq.com/minigame/dev/guide/runtime/debug/gamelogmanager.html#%E5%A6%82%E4%BD%95%E4%BD%BF%E7%94%A8)。开发者可通过 [wx.getGameLogManager](https://developers.weixin.qq.com/minigame/dev/api/data-analysis/wx.getGameLogManager.html) 获取游戏日志实例并上报相关游戏日志,日志会进行汇聚并实时上报到小游戏管理后台。
37+
38+
**注意**
39+
40+
1. 相对于用户反馈日志,小游戏实时日志**不需要用户反馈行为**
41+
2. 需要开发者通过相关API上报游戏关键节点信息与异常日志。
3242

33-
<img src='../image/issueforproduction3.png' width="800"/>
34-
相对于用户反馈日志,小游戏实时日志**不需要用户反馈行为**
3543

36-
但需要开发者上报游戏关键节点信息与异常日志。
44+
<img src='../image/issueforproduction3.png' width="800"/>
3745

3846

3947
## JS Error错误日志
40-
数据入口:MP平台-开发管理-错误日志
48+
49+
> 数据入口:[We分析](https://wedata.weixin.qq.com/)-性能质量-JS分析
4150
4251
微信小游戏框架会在顶层监控到任何**未捕捉的JS异常**
4352
<img src='../image/issueforproduction4.png' width="800"/>
@@ -47,10 +56,3 @@
4756
- 导出选项中禁用异常,当触发异常时将走到js abort相关逻辑,此处将产生异常。
4857
- 适配插件自身脚本错误
4958
- 其他JS层未捕获异常
50-
51-
52-
53-
54-
55-
56-

image/issueforproduction3.png

334 KB
Loading

image/issueforproduction4.png

89.1 KB
Loading

0 commit comments

Comments
 (0)