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