Application Real-Time Monitoring Service:Web および HTML5 向け RUM SDK 構成リファレンス

CDN 経由での初期化

Alibaba Cloud コンテンツデリバリーネットワーク (CDN) 経由で SDK を読み込む場合、RumSDK.default グローバル名前空間からアクセスします。

const ArmsRum = window.RumSDK.default;

// SDK の読み込み完了後に初期化します。
// SDK スクリプトタグより前に window.__rum を定義した場合は、このステップをスキップしてください。
ArmsRum.init({
  pid: "<your-app-id>",
  endpoint: "<your-endpoint>",
});

// ランタイムで構成を更新
ArmsRum.setConfig('env', 'pre');

npm 経由での初期化

import ArmsRum from '@arms/rum-browser';

ArmsRum.init({
  pid: "<your-app-id>",
  endpoint: "<your-endpoint>",
});

使用例

ArmsRum.init({
  pid: "<your-app-id>",
  endpoint: "<your-endpoint>",
  user: {
    name: 'your user.name',
    tags: 'your user.tags',
  },
});

使用例

ArmsRum.init({
  pid: "<your-app-id>",
  endpoint: "<your-endpoint>",
  reportConfig: {
    flushTime: 0,       // 即時送信
    maxEventCount: 50,  // 1 バッチあたり最大 50 イベント
  },
});

ストレージの詳細

storage パラメーターは、SDK が以下のデータを永続化する場所を決定します。

• _arms_uid — ユニークユーザー ID (user.id)

• _arms_session — ${sessionId}-${sampled}-${startTime}-${lastTime} 形式のセッションメタデータ：

  • sessionId — ユニークなセッション識別子

  • sampled — このセッションがサンプリングによって選択されたかどうか

  • startTime — セッション開始タイムスタンプ

  • lastTime — 最終アクティビティタイムスタンプ

使用例

ArmsRum.init({
  pid: "<your-app-id>",
  endpoint: "<your-endpoint>",
  sessionConfig: {
    sampleRate: 0.5,          // セッションの 50 % をサンプリング
    maxDuration: 86400000,    // 最大 24 時間
    overtime: 3600000,        // 非アクティブタイムアウトを 1 時間に設定
    storage: 'cookie',        // localStorage の代わりに cookie を使用
  },
});

使用例

ユーザー操作のトラッキングを無効化します。

ArmsRum.init({
  pid: "<your-app-id>",
  endpoint: "<your-endpoint>",
  collectors: {
    action: false,
  },
});

入力引数

戻り値の型 (IApiBaseAttr)

返されるフィールドは SDK のデフォルト値を上書きします。省略されたフィールドはデフォルト値のままになります。

使用例

ArmsRum.init({
  pid: "<your-app-id>",
  endpoint: "<your-endpoint>",
  evaluateApi: async (options, response, error) => {
    let respText = '';
    if (response && response.text) {
      respText = await response.text();
    }

    return {
      name: 'my-custom-api',
      success: error ? 0 : 1,
      snapshots: JSON.stringify({
        params: 'page=1&size=10',
        response: respText.substring(0, 2000),
        reqHeaders: '',
        resHeaders: '',
      }),
      properties: {
        prop_msg: 'custom msg',
        prop_num: 1,
      },
    };
  },
});

MatchOption 型

type MatchOption = string | RegExp | ((value: string) => boolean);

• 文字列 — 指定された値で始まる任意の URL またはメッセージと一致します。たとえば、'https://api.aliyun.com' は 'https://api.aliyun.com/v1/resource' と一致します。

• 正規表現 — URL またはメッセージを正規表現と照合します。

• 関数 — URL またはメッセージを入力として受け取ります。イベントを除外する場合は true を返します。

MatchOption 値の配列を渡すと、条件は指定された順序で評価されます。いずれかの条件に一致した場合、そのイベントは除外されます。

使用例

ArmsRum.init({
  pid: "<your-app-id>",
  endpoint: "<your-endpoint>",
  filters: {
    exception: [
      'Test error',                           // 「Test error」で始まるメッセージ
      /^Script error\.?$/,                    // この正規表現に一致するメッセージ
      (msg) => msg.includes('example-error'), // カスタムマッチ関数
    ],
    resource: [
      'https://example.com/',   // 「https://example.com/」で始まる URL
      /localhost/i,             // 「localhost」を含む URL
      (url) => url.includes('example-resource'),
    ],
  },
});

DetectionRule

トリガーイベント

検出方法

CustomTesterResult 型：

type CustomTesterResult = {
  hasContent: boolean;               // true = コンテンツが存在；false = ホワイトスクリーン検出
  message?: string;                  // エラーメッセージ
  snapshot?: Record<string, any>;    // 診断データ
}

ConfigOptions

SCREENSHOT および SAMPLE 検出方法に固有のオプションです。

SCREENSHOT オプション：

SAMPLE オプション：

共通オプション：

SCREENSHOT および SAMPLE の両方で debug オプション（Boolean、デフォルト：false）がサポートされています。有効にすると、検出の詳細がブラウザの開発者ツールコンソールに出力されます。

使用例

スクリーンショットベースの検出：

ArmsRum.init({
  pid: "<your-app-id>",
  endpoint: "<your-endpoint>",
  whiteScreen: {
    detectionRules: [{
      target: '#root',
      test_when: ['LOAD', 'ERROR', 'ROUTE_CHANGE', 'LEAVE'],
      delay: 5000,
      tester: 'SCREENSHOT',
      configOptions: {
        colorRange: ['rgb(255, 255, 255)', 'rgb(0, 0, 0)'],
        threshold: 0.9,
        pixels: 10,
        horizontalOffset: 210,
        verticalOffset: 50,
      },
    }],
  },
});

サンプリングベースの検出：

ArmsRum.init({
  pid: "<your-app-id>",
  endpoint: "<your-endpoint>",
  whiteScreen: {
    detectionRules: [{
      target: '#root',
      test_when: ['LOAD', 'ERROR', 'ROUTE_CHANGE', 'LEAVE'],
      delay: 5000,
      tester: 'SAMPLE',
      configOptions: {
        sampleMethod: 2,
        checkPoints: 10,
        threshold: 0.9,
        whiteBoxElements: ['.el-skeleton'],
      },
    }],
  },
});

カスタム検出関数：

ArmsRum.init({
  pid: "<your-app-id>",
  endpoint: "<your-endpoint>",
  whiteScreen: {
    detectionRules: [{
      target: '#root',
      test_when: ['LOAD', 'ERROR', 'ROUTE_CHANGE', 'LEAVE'],
      delay: 5000,
      tester: async (element) => {
        return {
          hasContent: false,
          message: 'Custom error message',
          snapshot: {
            checkPoints: 100,
            rate: 0.99,
            checkdata: '......',
          },
        };
      },
    }],
  },
});

マージ動作

• グローバルプロパティ（init() で設定）およびイベントレベルのプロパティ（evaluateApi、sendCustom、sendException、または sendResource を通じて設定）は、ストレージ時にマージされます。

• イベントレベルのプロパティが優先されます。同じキーが両方に存在する場合、イベントレベルの値が採用されます。

• マージ後、最大 20 キーと値のペアが保持されます。超過分はキーでソートされ、削除されます。

使用例

ArmsRum.init({
  pid: "<your-app-id>",
  endpoint: "<your-endpoint>",
  properties: {
    prop_string: 'xx',
    prop_number: 2,
    // 50 文字を超えるキーは切り捨てられます
    more_than_50_key_limit_012345678901234567890123456789: 'yy',
    // 2,000 文字を超える文字列値は切り捨てられます
    more_than_2000_value_limit: new Array(2003).join('1'),
    // 無効な型 — これらのペアは削除されます
    prop_null: null,
    prop_undefined: undefined,
    prop_bool: true,
  },
});

ステップ 1：ARMS コンソールで構成する

1. アプリケーション一覧 に移動し、ご利用のアプリケーションを開きます。

2. アプリケーション設定 ＞ SDK 構成 に移動します。

3. 目的の構成値を設定します。

4. 動的構成の更新を確定 をクリックして、設定をリモート Object Storage Service (OSS) サーバーにプッシュします。

ステップ 2：SDK で有効化する

初期化コードに、アプリケーションがホストされている remoteConfig フィールドを region とともに追加します。

CDN：

window.__rum = {
  pid: "<your-app-id>",
  endpoint: "<your-endpoint>",
  remoteConfig: {
    region: "cn-hangzhou"  // 例：シンガポールの場合は "ap-southeast-1"
  }
};

<script async src="https://xxid-sdk.rum.aliyuncs.com/v2/browser-sdk.js"></script>

npm：

import ArmsRum from '@arms/rum-browser';

ArmsRum.init({
  pid: "<your-app-id>",
  endpoint: "<your-endpoint>",
  remoteConfig: {
    region: "cn-hangzhou"  // 例：シンガポールの場合は "ap-southeast-1"
  }
});

キャッシュ動作

リモート構成を取得した後、SDK は設定をローカルにキャッシュします。以降の初期化では、SDK がキャッシュされた構成を優先します。

動的構成には、固定バージョン付き CDN を介してインポートする場合、SDK バージョン 0.0.37

使用例

ArmsRum.init({
  pid: "<your-app-id>",
  endpoint: "<your-endpoint>",
  geo: {
    country: 'your custom country info',
    city: 'your custom city info',
  },
});

getConfig

現在の SDK 構成を取得します。

const config = ArmsRum.getConfig();

setConfig

ランタイムで SDK 構成を更新します。単一のキーと値のペア、または完全な構成オブジェクトを渡します。

// 単一の値を設定
ArmsRum.setConfig('env', 'pre');

// 複数の値を設定
const config = ArmsRum.getConfig();
ArmsRum.setConfig({
  ...config,
  version: '1.0.0',
  env: 'pre',
});

sendCustom

カスタムイベントをレポートします。type および name フィールドは必須です。

ArmsRum.sendCustom({
  type: 'CustomEventType1',
  name: 'customEventName2',
  group: 'customEventGroup3',
  value: 111.11,
  properties: {
    prop_msg: 'custom msg',
    prop_num: 1,
  },
});

sendException

カスタム例外をレポートします。name および message フィールドは必須です。

ArmsRum.sendException({
  name: 'customErrorName',
  message: 'custom error message',
  file: 'custom exception filename',
  stack: 'custom exception error.stack',
  line: 1,
  column: 2,
  properties: {
    prop_msg: 'custom msg',
    prop_num: 1,
  },
});

sendResource

カスタムリソースイベントをレポートします。name、type、および duration フィールドは必須です。

ArmsRum.sendResource({
  name: 'getListByPage',
  message: 'success',
  duration: 800,
  url: 'https://www.aliyun.com/data/getListByPage',
  properties: {
    prop_msg: 'custom msg',
    prop_num: 1,
  },
});