接入鸿蒙应用

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请求方法，传空字符串即可	当次网络事件不采集
   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请求方法，传空字符串即可	当次网络事件不采集
   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
  })