Alipay ミニプログラムのモニタリング - Application Real-Time Monitoring Service

このトピックでは、Application Real-Time Monitoring Service (ARMS) のブラウザーモニタリング機能を使用して Alipay ミニプログラムをモニタリングする方法について説明し、ブラウザーモニタリング機能の一般的な SDK 設定、API 操作、および高度なシナリオを紹介します。

基本的な使用方法

npm パッケージを導入して初期化します。
1. ログレポートを容易にするために、ミニプログラムプロジェクトに名前が @arms/js-sdkの npm パッケージを導入します。
```
npm install @arms/js-sdk
```
2. /utils ディレクトリの monitor.js ファイルに以下の情報を追加して、パッケージを初期化します。
  説明
  JavaScript (JS) ファイルの名前と格纳パスを指定できます。
```
import AlipayLogger from '@arms/js-sdk/miniapp';
const Monitor = AlipayLogger.init({
    pid: 'xxx',
    region: 'cn', // The region where the application is deployed. Set region to cn if the application is deployed in China and set region to sg if the application is deployed outside China.
});

export default Monitor;              
```
  説明
  パラメーター設定の詳細については、「SDK の一般的なパラメーター」をご参照ください。
セキュリティドメイン名を設定します。
- region が cn に設定されている場合、HTTPセキュリティドメインに arms-retcode.aliyuncs.com を追加します。
- region が sg に設定されている場合、HTTP セキュリティドメインに arms-retcode-sg.aliyuncs.com を設定します。

その他の API メソッド

メソッド	パラメーター	説明
setCommonInfo	{[key: string]: string;}	段階的リリースなど、シナリオに対する基本的なログフィールドを設定します。
setConfig	{[key: string]: string;}	設定フィールドを設定します。詳細については、「SDK リファレンス」をご参照ください。
pageShow	{}	PV データを送信します。
pageHide	{}	ヘルスデータを送信します。
error	文字列/オブジェクト	エラーログを送信します。
api	詳細については、「SDK メソッド」をご参照ください。	API ログをレポートします。
sum/avg	文字列	カスタムの合計ログと平均ログをレポートします。

高度なシナリオ

基本的な使用方法では要件を満たせない場合は、以下の高度なシナリオをご参照ください。

API リクエストの結果を手動でレポートします。
1. disableHook を true に設定します。 my.httpRequest のログは自動的にはレポートされません。
2. api() メソッドを手動で呼び出して、API 操作をレポートします。
自動レポートを無効化し、手動計測を有効化します。
1. app.js および page.js ファイルでは、hookApp および hookPage メソッドを使用しないでください。
2. ページの PV データを送信するには、onShowメソッドで pageShow() メソッドを呼び出します。
  説明
  hookPage() メソッドと pageShow() メソッドを一緒に呼び出さないことを推奨します。一緒に呼び出した場合、PV ログが繰り返し報告されます。
```
import Monitor from '/util/monitor';
Page({
    onShow: function() {
        Monitor.pageShow();
    }
})
```
3. ページのヘルスデータ (ヘルスと閲覧時間) を送信するには、onHideメソッドとonUnloadメソッドでpageHide() メソッドを呼び出します。
  説明
  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。値は、ユーザの識別子であり、ユーザを検索するために使用することができる。カスタム値を指定できます。このパラメーターを指定しない場合、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 リファレンス」をご参照ください。