すべてのプロダクト
Search

このプロダクト

    :Alipay ミニプログラムの監視

    ドキュメントセンター

    :Alipay ミニプログラムの監視

    最終更新日:Dec 30, 2024

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

    基本的な使用方法

    1. 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', // アプリケーションがデプロイされているリージョン。アプリケーションが中国にデプロイされている場合は cn に設定し、中国以外にデプロイされている場合は sg に設定します。
});

export default Monitor;
        説明

        パラメータ設定の詳細については、SDK の共通パラメータを参照してください。

    2. セキュリティドメイン名を設定します。

      • region が cn に設定されている場合は、arms-retcode.aliyuncs.com を HTTP セキュリティドメインに追加します。

      • region が sg に設定されている場合は、arms-retcode-sg.aliyuncs.com を HTTP セキュリティドメインに追加します。

    その他の API メソッド

    メソッド

    パラメータ

    説明

    setCommonInfo

    {[key: string]: string;}

    段階的リリースなどのシナリオの基本ログフィールドを設定します。

    setConfig

    {[key: string]: string;}

    config フィールドを設定します。詳細については、SDK リファレンスを参照してください。

    pageShow

    {}

    PV データを計測します。

    pageHide

    {}

    ヘルスデータ を計測します。

    error

    String/Object

    エラーログを計測します。

    api

    詳細については、SDK メソッドを参照してください。

    API ログをレポートします。

    sum/avg

    String

    カスタムの合計および平均ログをレポートします。

    高度なシナリオ

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

    • API リクエストの結果を手動でレポートします。

      1. disableHook を true に設定します。my.httpRequest のログは自動的にレポートされません。

      2. api() メソッドを手動で呼び出して、API 操作をレポートします。

    • 自動レポートを無効にし、手動計測を有効にします。

      1. app.js ファイルと page.js ファイルで hookApp メソッドと hookPage メソッドを使用しないでください。

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

        説明

        pageShow() メソッドを hookPage() メソッドと一緒に呼び出さないことをお勧めします。そうしないと、PV ログが繰り返しレポートされます。

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

      3. ページのヘルスデータ（ヘルスと閲覧時間）を送信するには、pageHide() メソッドを onHide メソッドと onUnload メソッドで呼び出します。

        説明

        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

    入力タグ。各ログにはタグが付いています。

    いいえ

    なし

    release

    String

    アプリケーションのバージョン。異なるバージョンのレポート情報を表示するために、このパラメータを設定することをお勧めします。

    いいえ

    undefined

    environment

    String

    環境フィールド。有効な値：prod、gray、pre、daily、および local。

    • 値 prod はオンライン環境を示します。

    • 値 gray は段階的リリース環境を示します。

    • 値 pre はステージング環境を示します。

    • 値 daily は日次環境を示します。

    • 値 local はローカル環境を示します。

    いいえ

    prod

    sample

    Integer

    ログサンプリング設定。値は 1 から 100 までの整数です。パフォーマンスログと成功 API ログは、1/sample の比率でサンプリングされます。パフォーマンスログと成功 API ログのメトリックの詳細については、統計メトリックを参照してください。

    いいえ

    1

    behavior

    Boolean

    トラブルシューティングを容易にするために、エラーを報告するユーザーの行動を記録するかどうかを指定します。

    いいえ

    false

    enableLinkTrace

    Boolean

    バックツーバックトレース分析の詳細については、フロントツーバックトレース機能を使用して API エラーを診断するを参照してください。

    いいえ

    false

    ARMS ブラウザ監視は、他の SDK パラメータも提供します。詳細については、SDK リファレンスを参照してください。