npm を使用して ARMS ブラウザ監視エージェントをインストールする方法 - Application Real-Time Monitoring Service

Application Real-Time Monitoring Service (ARMS) のブラウザ監視機能を使用して Web アプリケーションを監視するには、まず Content Delivery Network (CDN) または Node Package Manager (npm) を使用して ARMS エージェントをインストールする必要があります。このトピックでは、npm を使用して Web アプリケーションに ARMS ブラウザ監視エージェントをインストールする方法について説明します。

インストール

npm リポジトリから @arms/js-sdk パッケージをインストールします。

npm install @arms/js-sdk --save

初期化

BrowserLogger.singleton を使用して SDK を初期化します。

const BrowserLogger = require('@arms/js-sdk');
const __bl = BrowserLogger.singleton(
  {
    pid:"your-project-id",
    appType:"web",
    imgUrl:"https://arms-retcode.aliyuncs.com/r.png?",
    // その他の構成設定。
  }
);

npm を使用して ARMS ブラウザ監視エージェントをインストールすると、Web SDK (ソフトウェア開発キット) は自動的にユーザー ID (UID) を生成し、ユニークビジター (UV) 数などの情報を収集します。生成された UID はユーザーの識別に利用できますが、ビジネス属性は含まれません。UID をカスタマイズするには、次の内容をコードに追加します。

uid: 'xxx', // UID はユーザーを識別するために使用されます。必要に応じて値を設定してください。

例:

const BrowserLogger = require('@arms/js-sdk');
const __bl = BrowserLogger.singleton(
  {
    pid:"your-project-id",
    appType:"web",
    uid: 'xxx',
    imgUrl:"https://arms-retcode.aliyuncs.com/r.png?",
    // その他の構成設定。
  }
);

API リファレンス

@static singleton(): シングルトンオブジェクトの取得

説明

このメソッドは、npm を使用して SDK をインポートする場合にのみ適用されます。

構文: BrowserLogger.singleton(config,prePipe)

これは、シングルトンオブジェクトを返す静的メソッドです。config および prePipe パラメーターは、メソッドが初めて呼び出されたときにのみ有効になります。その後の呼び出しでは、生成されたインスタンスのみが返されます。

パラメーター	タイプ	説明	必須	デフォルト値
config	Object	サイト構成。config の他の設定項目については、「SDK リファレンス」をご参照ください。	はい	なし
prePipe	Array	事前レポートする内容。	いいえ	なし

このメソッドを使用して、アプリケーションのエントリポイントで SDK を初期化したり、呼び出しごとにインスタンスを取得したりできます。

その他のレポート API

BrowserLogger.singleton を使用してインスタンスを取得します。

const __bl = BrowserLogger.singleton();

__bl の他の API の詳細については、「フロントエンド API リファレンス」をご参照ください。

Config 構成

config パラメーターは CDN インポートの場合と同じです。詳細については、「SDK リファレンス」をご参照ください。

事前レポート

BrowserLogger.singleton() を呼び出す前に実行されるロジックからデータをレポートするには、事前レポート機能を使用する必要があります。詳細については、「事前レポートデータ」をご参照ください。

const BrowserLogger = require('@arms/js-sdk');
                // pipe の構造は CDN インポートの場合と同じです。
                const pipe = [
                // 現在の HTML ページを API としてレポートします。
                ['api', '/index.html', true, performance.now, 'SUCCESS'], // これは __bl.api(api, success, time, code, msg) と同等です。
                // SDK が初期化されると、自動 SPA 解析が有効になります。
                ['setConfig', {enableSPA: true}]
                ];
                const __bl = BrowserLogger.singleton({pid:'Unique site ID'},pipe);

一般的な SDK 設定項目

ブラウザ監視は、特定の要件を満たすために設定できる一連の 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	ブール値	トラブルシューティングを容易にするために、エラーを報告するユーザーの動作を記録するかどうかを指定します。	いいえ	`true`
enableSPA	ブール値	ページの hashchange イベントをリッスンし、PV を再度レポートします。これは、シングルページアプリケーション (SPA) のシナリオに適用できます。	いいえ	`false`
enableLinkTrace	ブール値	バックツーバックのトレース分析の詳細については、「フロントツーバックのトレース機能を使用して API エラーを診断する」をご参照ください。	いいえ	`false`

ブラウザ監視は、高度な要件を満たすためのより多くの SDK 設定項目を提供します。詳細については、「SDK リファレンス」をご参照ください。