Cloud Monitor：接入鴻蒙應用

Axios 網路採集

1. （可選配置）端對端的全鏈路打通需要在要求標頭中插入Alibaba的自訂業務要求標頭，如不需要全鏈路業務可跳過此步驟。注意，若使用端對端全鏈路打通功能，需要事先在控制台配置 host 白名單，具體操作請參見 App監控關聯前後端Trace。

   重要

   每條網路請求自訂頭都需要重新擷取賦值，非同一個requestUrl的API調用結果不要複用！

   function getInsertHeaderMap(requestUrl: string): Map<string, string> | undefined

   參數	是否必要	說明	參數限制	失敗結果
   requestUrl	必要	請求URL	String類型。有效請求地址	當次擷取無效

   //樣本通過`AxiosRequestConfig`插入要求標頭，您也可以通過實現請求攔截器處理`InternalAxiosRequestConfig.headers`進行插頭操作
   import axios, {
     AxiosError,
     AxiosHeaders,
     AxiosResponse,
     AxiosRequestConfig,
     InternalAxiosRequestConfig
   } from '@ohos/axios'
   import { AlibabaCloudRumTrace } from '@alibabacloud_rum/harmony_sdk'
   
   let customHeaders: AxiosHeaders = new AxiosHeaders()
   let traceHeader = AlibabaCloudRumTrace.axios.getInsertHeaderMap("https://www.example.com");
   if (traceHeader) {
     traceHeader.forEach((value: string, key: string) => {
       customHeaders.set(key, value);
     })
   }
   // 通過AxiosRequestConfig插入到實際要求標頭中
   let requestConfig: AxiosRequestConfig = {
     method: this.currMethod,
     headers: customHeaders,
     params: this.currRequestParam
   }
   axios.get("https://www.example.com", requestConfig);

2. （必要配置）採集正常/異常網路資料。

   function handleSuccess(requestUrl: string, method: string, responseCode: number,
       requestDataSizeByte?: number, downloadSizeByte?: number,
       timingParam?: object, remoteAddressIP?: string, requestHeader?: Record<string, Object>,
       responseHeader?: Record<string, Object>, resourceType?: string, requestBody?: string)

   參數說明：

   參數	是否必要	說明	參數限制	失敗結果
   requestUrl	必要	請求URL	String類型。有效請求地址	當次網路事件不採集
   method	必要	要求方法	String類型。非HTTP要求方法，傳Null 字元串即可	當次網路事件不採集
   responseCode	必要	響應碼	Number類型	當次網路事件不採集
   requestDataSizeByte	可選	請求上傳資料大小	Number類型（單位Byte）	當次網路事件不採集
   downloadSizeByte	可選	下載大小	Number類型（單位Byte）	當次網路事件不採集
   timingParam	可選	axios 請求各個階段所花費的時間	http.PerformanceTiming類型	當次網路事件不採集
   remoteAddressIP	可選	目標地址IP	String類型	當次網路事件缺失相關欄位
   requestHeader	可選	請求Header，當需要使用鏈路打通功能，此參數需要必傳	Record類型	當次網路事件缺失相關欄位
   responseHeader	可選	響應header	Record類型	當次網路事件缺失相關欄位
   resourceType	可選	資源類型	String類型。遵循MIME類型的Content-Type欄位	當次網路事件缺失相關欄位
   requestBody	可選	請求內容	String類型	當次網路事件缺失相關欄位

   採集異常網路資料：

   function handleError(requestUrl: string, method: string, requestDataSizeByte: number, errorParam: Error,requestHeader?: Record<string, Object>)

   參數	是否必要	說明	參數限制	失敗結果
   requestUrl	必要	請求URL	String類型。有效請求地址	當次網路事件不採集
   method	必要	要求方法	String類型。非HTTP要求方法，傳Null 字元串即可	當次網路事件不採集
   requestDataSizeByte	必要	請求上傳資料大小	Number類型（單位Byte）	當次網路事件不採集
   errorParam	必要	網路Error錯誤	BusinessError類型	當次網路事件不採集
   requestHeader	可選	請求header	Record類型	當次網路事件缺失相關欄位

   樣本如下：

   axios.get("http://www.example.com"，requestConfig).then((responseData: AxiosResponse) => {
     AlibabaCloudRumTrace.axios.handleSuccess("http://www.example.com", "GET", responseData.status, requestDataSize, downloadSize, responseData.performanceTiming);
   }).catch((err: BusinessError) => {
     AlibabaCloudRumTrace.axios.handleError("http://www.example.com", "GET", 0, err);
   });

Webview 資料擷取

在 Web 元件的生命週期回調中添加 SDK 採集邏輯，具體如下：

1. 插入js指令碼：

   在javaScriptOnDocumentStart的參數中，添加 AlibabaCloudRumTrace.Web.getScriptItem()。

2. 在 onPageEnd 生命週期埋點：

   在 onPageEnd 中添加AlibabaCloudRumTrace.Web.onPageEndHilt(this.controller);。

3. 在卸載組件時銷毀 SDK 相關採集資源：

   在onDisAppear中添加AlibabaCloudRumTrace.Web.onDisAppearHilt(this.controller)。

程式碼範例：

import { AlibabaCloudRumTrace } from '@alibabacloud_rum/harmony_sdk';

Web()
  .javaScriptOnDocumentStart([AlibabaCloudRumTrace.Web.getScriptItem()])
  .onPageEnd(() => {
    AlibabaCloudRumTrace.Web.onPageEndHilt(this.controller); 
    // this.controller:必須是當前Web綁定的WebviewController
  })
  .onDisAppear(() => {
    AlibabaCloudRumTrace.Web.onDisAppearHilt(this.controller);
    // this.controller:必須是當前Web綁定的WebviewController
  })