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

背景情報

WeChat ミニプログラムの背景情報については、「WeChat ミニプログラムのドキュメント」をご参照ください。

基本的な使用方法

ARMS ブラウザ監視で WeChat ミニプログラムを監視するには、次の 3 つのステップを実行します。

1. WeChat ミニプログラム監視 SDK を取得して初期化します。

   1. WeChat ミニプログラムプロジェクトの/utils ディレクトリに、wxLogger.js という名前のファイルを作成します。「監視SDKのJSファイル」の内容をコピーし、wxLogger.js ファイルに貼り付けます。
   2. /utils ディレクトリにmonitor.js という名前のファイルを作成し、次のコードをmonitor.js ファイルに追加して SDK を初期化します。
      説明 ファイル名と保存場所はカスタマイズできます。

      • プロジェクトで Node.js モジュール (require) を使用している場合は、次のコードを追加します。

        const WXLogger = require('./wxLogger.js');
        const Monitor = WXLogger.init({
          pid: 'xxx',
          region: 'cn', // デプロイリージョン：cn (中国本土)、sg (シンガポール近辺の海外リージョン)
        });
        export default Monitor;

      • プロジェクトで ES モジュール (import) を使用している場合は、次のコードを追加します。

        import WXLogger from './wxLogger.js';
        const Monitor = WXLogger.init({
          pid: 'xxx',
          region: 'cn', // デプロイリージョン：cn (中国本土)、sg (シンガポール近辺の海外リージョン)
        });
        export default Monitor;

      region をアプリケーションのデプロイリージョンに設定します。中国本土の場合はcn、シンガポールに近い中国本土以外のリージョンの場合はsg に設定します。

      説明 詳細なパラメータ設定については、「SDK パラメータ」をご参照ください。

2. 自動インスツルメンテーションを有効にして、PV、エラー、API、パフォーマンス、および健全性データを収集します。

   1. app.js で、Monitor.hookApp(options) メソッドを使用してエラーログを自動的にキャプチャします。options パラメータは、App() に渡すオブジェクト設定です。

      import Monitor from '/utils/monitor';
      
      App(Monitor.hookApp({
        onError(err) {
          console.log('Enter onError:', err);
        },
        onLaunch() {
          console.log('Enter onLaunch');
        },
        onShow(options) {
        },
        onHide() {
        }
      }));

   2. 各ページの JS ファイルで、Monitor.hookPage(options) メソッドを使用して API リクエスト、PV、および健全性データを自動的に報告します。

      import Monitor from '/utils/monitor';
      
      // hookPageを使用すると、ライフサイクルAPIが自動的にインスツルメント化されます。
      Page(Monitor.hookPage({
        data: {},
        onLoad(query) {
        },
        onReady() {
          // ページが読み込まれました。
        },
        onShow() {
        },
        onHide() {
        },
        onUnload() {
        }
      }));

3. セキュリティドメインを設定します。region の値に対応する ARMS ドメインを、WeChat ミニプログラムの有効なリクエストドメインのリストに追加します。

   • region がcn に設定されている場合は、https://arms-retcode.aliyuncs.com を有効なリクエストドメインのリストに追加します。

   • region がsg に設定されている場合は、https://arms-retcode-sg.aliyuncs.com を有効なリクエストドメインのリストに追加します。

SDK パラメータ

ARMS ブラウザ監視は、追加の要件を満たすために設定できる SDK 設定パラメータを提供しています。次の表は、WeChat ミニプログラムに適用される一般的な設定パラメータを示しています。

ARMS ブラウザ監視は、さらなる要件に対応するための追加の SDK 設定パラメータも提供しています。詳細については、「SDK 設定パラメータ」をご参照ください。

自動インスツルメンテーションAPI

次の表は、WeChat ミニプログラム監視 SDK がライフサイクルの自動インスツルメンテーションのために提供するメソッドを示しています。

その他の設定API

次の表は、WeChat ミニプログラム監視 SDK を設定し、データを報告するために呼び出すことができるメソッドを示しています。

高度な使用例

「基本的な使用方法」で説明されている自動インスツルメンテーションメソッドが要件を満たさない場合は、次の高度な設定のいずれかを使用します。

• 自動インスツルメンテーションの代わりに API 情報を手動で報告する：

  1. disableHook をtrue に設定して、wx.request リクエストの自動ログ報告を無効にします。

  2. 手動でapi() メソッドを呼び出して API 情報を報告します。

• 自動インスツルメンテーションを無効にして、ページを手動でインスツルメント化する：

  1. App および Page の JS ファイルで hookApp または hookPage メソッドを使用しません。

  2. 現在のページの PV データを送信するには、ページのonShow メソッドでpageShow() メソッドを呼び出します。

     説明 このメソッドをhookPage() と一緒に使用しないでください。使用した場合、重複した PV データが報告されます。

     import Monitor from '/utils/monitor';
     
     Page({
       onShow: function() {
         Monitor.pageShow();
       }
     })

  3. 現在のページの健全性データ (ページの健全性やページ滞在時間など) を送信するには、ページのonHide メソッドとonUnload メソッドでpageHide() メソッドを呼び出します。

     説明 このメソッドをhookPage() と一緒に使用しないでください。使用した場合、重複した健全性データが報告されます。

     import Monitor from '/utils/monitor';
     
     Page({
       onHide: function() {
         Monitor.pageHide();
       },
       onUnload: function() {
         Monitor.pageHide();
       }
       // その他のライフサイクルメソッド。
     })