ARMS Browser SDK による Alipay ミニプログラムの性能追跡 - ARMS - Alibaba Cloud - Application Real-Time Monitoring Service

Alipay ミニプログラムに Application Real-Time Monitoring Service (ARMS) ブラウザ監視 SDK をインストールして初期化することで、ミニプログラムの監視を開始します。このトピックでは、ARMS ブラウザ監視がサポートする一般的な SDK パラメータ、API メソッド、および高度なシナリオについても説明します。

前提条件

ARMS ブラウザ監視で監視するアプリケーションの pid です。SDK の初期化時にこの値を設定します。
npm パッケージをインストールできる Alipay ミニプログラムプロジェクト。

基本的な使用方法

次の手順に従って、ARMS ブラウザ監視 SDK を Alipay ミニプログラムに統合します。

SDK の初期化に使用する region の値に対応する HTTP セキュリティドメインを設定します:
- region を cn に設定する場合は、HTTP セキュリティドメインに arms-retcode.aliyuncs.com を追加してください。
- region を sg に設定した場合、HTTP セキュリティドメインに arms-retcode-sg.aliyuncs.com を追加します。
モジュールを使用してログを報告するには、Alipay ミニプログラムプロジェクトで @arms/js-sdk npm パッケージをインストールします。
```
npm install @arms/js-sdk
```
/utils ディレクトリ内の monitor.js ファイルに以下のコードを追加して、初期化を完了します。
```
import AlipayLogger from '@arms/js-sdk/miniapp';
const Monitor = AlipayLogger.init({
    pid: 'xxx',
    region: 'cn', // アプリケーションがデプロイされているリージョンを指定します。中国大陸内の場合は cn、中国以外のリージョンの場合は sg に設定します。
});

export default Monitor;
```
説明
JS ファイルには、カスタム名と場所を使用できます。
pid、region、および init() に渡すその他のパラメーターの説明については、「共通 SDK パラメーター」をご参照ください。

一般的なSDKパラメータ

ARMS ブラウザ監視は、追加の要件を満たすために設定できる SDK パラメータを提供します。次の表で、一般的に使用されるパラメータについて説明します。

パラメータ	タイプ	説明	必須	デフォルト
	pid		String		プロジェクトの一意のID。サイトを作成するときにARMSによって自動的に生成されます。	はい	なし
	uid		String		ユーザーの ID。値は、ユーザの識別子であり、ユーザを検索するために使用することができる。カスタム値を指定できます。このパラメーターを指定しない場合、SDKは6か月ごとに自動的に生成および更新されます。	いいえ	SDKによって自動的に生成される
	tag		String		inputタグ。各ログにはタグが付いています。	いいえ	なし
	release		String		アプリケーションのバージョン。このパラメーターを設定して、異なるバージョンのレポート情報を表示することを推奨します。	いいえ	`undefined`
	environment		String		環境フィールド。有効な値: prod、gray、pre、daily、local。値prodはオンライン環境を示します。グレーの値は、段階的リリース環境を示します。値preは、ステージング環境を示す。値dailyは、毎日の環境を示します。値localは、ローカル環境を示す。	いいえ	`prod`
	sample		Integer		ログサンプリング設定。値は1から100までの整数です。パフォーマンスログと成功APIログは、`1 /サンプル`の比率でサンプリングされます。パフォーマンスログと成功APIログのメトリックの詳細については、「統計メトリック」をご参照ください。	いいえ	`1`
	behavior		Boolean		トラブルシューティングを簡単にするために、エラーを報告するユーザーの行動を記録するかどうかを指定します。	いいえ	`false`
	enableLinkTrace		Boolean		バックツーバックトレース分析の詳細については、「フロントツーバックトレース機能を使用したAPIエラーの診断」をご参照ください。	いいえ	`false`

ARMS ブラウザ監視は、その他の要件に対応するために、より多くの SDK パラメータも提供します。完全なリストについては、「ブラウザ監視 SDK 設定」をご参照ください。

APIメソッド

メソッド	パラメータ	説明
`setCommonInfo`	{[key: string]: string;}	基本的なログフィールドを設定します。カナリアリリースなどのシナリオでこのメソッドを使用します。
`setConfig`	{[key: string]: string;}	`config` フィールドを設定します。詳細については、「SDK リファレンス」をご参照ください。
`pageShow`	{}	ページ表示イベントを計測し、ページビュー (PV) データをレポートします。
`pageHide`	{}	ページ非表示イベントを計測し、正常性データをレポートします。
`error`	String/Object	エラーログを計測してレポートします。
`api`	「フロントエンド API リファレンス」をご参照ください。	API ログをレポートします。
`sum`/`avg`	String	カスタムの合計ログおよび平均ログをレポートします。

高度なシナリオ

ARMS ブラウザ監視 SDK の基本的な使用方法は、SDK が自動的にログをレポートするデフォルトの方法です。基本的な使用方法が要件を満たさない場合は、次の高度なシナリオのいずれかを使用してください。

自動レポートの代わりに API 情報を手動でレポートする

my.httpRequest リクエストに対するログの自動報告を無効にするには、disableHook を true に設定します。
手動で api() メソッドを呼び出して API 情報を報告します。

自動レポートの無効化と手動インストルメンテーションへの切り替え

App と Page に対応する JS ファイル内の hookApp メソッドと hookPage メソッドの使用を停止します。
現在のページのページビュー (PV) データを送信するには、ページの onShow メソッド内で pageShow() メソッドを呼び出します。
```
import Monitor from '/utils/monitor';
Page({
    onShow: function() {
        Monitor.pageShow();
    }
})
```

現在のページのヘルスデータを送信し、ページの滞在時間を収集するには、ページの onHide および onUnload メソッド内で pageHide() メソッドを呼び出します。

import Monitor from '/utils/monitor';
  Page({

      onHide: function() {
          Monitor.pageHide();
      },
      onUnload: function() {
          Monitor.pageHide();
      }
      // その他のページライフサイクルメソッド。
  })

説明

pageShow() または pageHide() を hookPage() メソッドと組み合わせて使用しないでください。そうしないと、ログが繰り返し報告されます。

Application Real-Time Monitoring Service:Alipay ミニプログラムの監視