開始監(jiān)控支付寶小程序
本文介紹如何使用ARMS前端監(jiān)控開始監(jiān)控支付寶小程序,以及相關(guān)的通用配置、API方法和進(jìn)階場景。
背景信息
關(guān)于支付寶小程序的背景信息,請參見支付寶小程序。
基礎(chǔ)使用方法
基礎(chǔ)方法包含引入npm包并初始化、上報和設(shè)置安全域名這三個步驟:
引入npm包并初始化:
在支付寶小程序的項目中引入
alife-logger
npm包,以便使用該模塊來上報日志。npm install alife-logger
將以下內(nèi)容添加至 /utils目錄下的monitor.js文件中以完成初始化。
說明您可以自定義JS文件的名稱和存放位置。
import AlipayLogger from 'alife-logger/alipay'; const Monitor = AlipayLogger.init({ pid: 'xxx', region: "cn", // 指定應(yīng)用部署的地域:中國設(shè)為cn,中國以外地域設(shè)為sg。 }); export default Monitor;
說明關(guān)于參數(shù)的詳細(xì)配置,請參見通用SDK配置項。
使用以下方法靜默采集PV、Error、API、性能及Health數(shù)據(jù):
在app.js中,使用Monitor.hookApp(options)方法靜默捕獲Error類日志。其中的options即為App層相應(yīng)的Object配置。
import Monitor from '/util/monitor'; App(Monitor.hookApp({ onError(err) { console.log('進(jìn)入onError:', err); }, onLaunch() { console.log('進(jìn)入onLaunch'); }, onShow(options) { }, onHide() { } }));
在page的JS文件中通過Monitor.hookPage(options)方法靜默上報API請求、PV、Health數(shù)據(jù)。
import Monitor from '/util/monitor'; // 使用hookPage后,生命周期的API會自動打點。 Page(Monitor.hookPage({ data: {}, onLoad(query) { }, onReady() { // 頁面加載完成。 }, onShow() { }, onLoad(query) { }, onHide() { }, onUnload() { } }));
設(shè)置安全域名:
如果region設(shè)為
cn
,則將arms-retcode.aliyuncs.com添加到HTTP安全域名。如果region設(shè)為
sg
,則將arms-retcode-sg.aliyuncs.com添加到HTTP安全域名。
API方法:靜默打點基礎(chǔ)API
方法 | 參數(shù) | 備注 | 示例使用場景 |
hookApp | {} | 請傳入原有的App參數(shù)。 | 在App的生命周期中自動打點。 |
hookPage | {} | 請傳入原有的Page參數(shù)。 | 在Page的生命周期中自動打點。 |
小程序監(jiān)控項目如需使用hookApp、hookPage嵌入生命周期打點,必須符合標(biāo)準(zhǔn)小程序關(guān)于App和Page的規(guī)范,即App層有onError,Page層有onShow、onHide、onUnload。使用方法示例,請參見基礎(chǔ)使用方法。
API方法:其他設(shè)置API
方法 | 參數(shù) | 備注 |
setCommonInfo | {[key: string]: string;} | 設(shè)置日志基礎(chǔ)字段,可用于灰度發(fā)布等場景。 |
setConfig | {[key: string]: string;} | 設(shè)置config字段,具體操作,請參見SDK參考。 |
pageShow | {} | Page Show打點,發(fā)送PV數(shù)據(jù)。 |
pageHide | {} | Page Hide打點,發(fā)送Health數(shù)據(jù)。 |
error | String/Object | 錯誤日志打點。 |
api | 請參見前端接口說明 | API類日志上報。 |
sum/avg | String | 自定義求和、求均值日志上報。 |
進(jìn)階場景
當(dāng)基礎(chǔ)使用方法無法滿足需求時,請參見以下進(jìn)階場景:
手動上報API相關(guān)信息(不采用靜默上報方式):
將disableHook設(shè)為
true
,不靜默上報my.httpRequest請求的日志。手動調(diào)用api()方法上報API相關(guān)信息。
取消靜默上報并改為手動打點:
在App和Page對應(yīng)的JS文件中不再使用hookApp、hookPage方法。
如需發(fā)送當(dāng)前頁面的PV數(shù)據(jù),則在Page的onShow方法下調(diào)用pageShow()方法。
說明請勿與hookPage()方法同時使用此方法,否則會造成PV類日志重復(fù)上報。
import Monitor from '/util/monitor'; Page({ onShow: function() { Monitor.pageShow(); } })
如需發(fā)送當(dāng)前頁面的Health類數(shù)據(jù),統(tǒng)計當(dāng)前頁面的健康度和頁面停留時間,則在Page的onHide和onUnload方法下調(diào)用pageHide()方法。
說明請勿與hookPage()方法同時使用此方法,否則會造成日志重復(fù)上報。
import Monitor from '/util/monitor'; Page({ onHide: function() { Monitor.pageHide(); }, onUnload: function() { Monitor.pageHide(); } ... })
通用SDK配置項
ARMS前端監(jiān)控提供一系列SDK配置項,讓您能夠通過設(shè)置參數(shù)來滿足額外需求。以下是適用于本文場景的通用配置項。
|
|
|
|
|
pid | String | 項目唯一ID,由ARMS在創(chuàng)建站點時自動生成。 | 是 | 無 |
uid | String | 用戶ID,用于標(biāo)識訪問用戶,可手動配置,用于根據(jù)用戶ID檢索。如果不配置,則由SDK隨機(jī)自動生成且每半年更新一次。 | 否 | 由SDK自動生成 |
tag | String | 傳入的標(biāo)記,每條日志都會攜帶該標(biāo)記。 | 否 | 無 |
release | String | 應(yīng)用版本號。建議您配置,便于查看不同版本的上報信息。 | 否 |
|
environment | String | 環(huán)境字段,取值為:prod、gray、pre、daily和local,其中:
| 否 |
|
sample | Integer | 日志采樣配置,值為1~100的整數(shù)。對性能日志和成功API日志按照 | 否 |
|
behavior | Boolean | 是否為了便于排查錯誤而記錄報錯的用戶行為。 | 否 |
|
enableLinkTrace | Boolean | 進(jìn)行前后端鏈路追蹤,請參見使用前后端鏈路追蹤診斷API錯誤原因。 | 否 |
|
ARMS前端監(jiān)控還提供了更多SDK配置項,可滿足進(jìn)一步的需求。更多信息,請參見SDK參考。