Application Real-Time Monitoring Service:ミニゲーム用 RUM SDK のサンプル構成

SDK パラメーター

ユーザーパラメーター

例

armsRum.init({
  pid: "your app id",
  endpoint: "your endpoint",
  user: {
    name: 'your user.name',
    tags: 'your user.tags',
  },
});

reportConfig パラメーター

例

armsRum.init({
  pid: "your app id",
  endpoint: "your endpoint",
  reportConfig: {
    flushTime: 0, // データが即時レポートされるように指定します。
    maxEventCount: 50, // 一度にレポートされるデータエントリの最大数を指定します。
  },
});

sessionConfig パラメーター

ユーザー ID とセッション情報は、ミニゲームのローカルキャッシュに保存されます。

• _arms_uid: 一意のユーザー ID （ user.id ）。

• _arms_session: セマンティックセッション情報。

  • sessionId: 一意のセッション ID 。

  • sampled: サンプリングがトリガーされたかどうかを示します。

  • startTime: セッションの開始タイムスタンプ。

  • lastTime: セッションが最後にアクティブになったタイムスタンプ。

`${sessionId}-${sampled}-${startTime}-${lastTime}`

例

armsRum.init({
  pid: "your app id",
  endpoint: "your endpoint",
  sessionConfig: {
    sampleRate: 0.5, // 50% のサンプリングレートを指定します。
    maxDuration: 86400000,
    overtime: 3600000,
  },
});

コレクター パラメーター

SDK は、API や例外などのコレクターを使用して、ミニゲームのモニタリングデータを収集します。

例

次の例では、ユーザー操作データの収集は無効になっています。

armsRum.init({
  pid: "your app id", // アプリID
  endpoint: "your endpoint", // エンドポイント
  collectors: {
    api: false, // API 収集を無効化
  },
});

evaluateApi パラメーター

evaluateApi 関数は、API リクエストイベントのカスタム解析を提供します。

この関数は非同期で呼び出すことができます。 Promise<IApiBaseAttr> が返されます。次の表は IApiBaseAttr について説明しています。

例

armsRum.init({
  pid: "your app id",
  endpoint: "your endpoint",
  evaluateApi: async (options, response, error) => {
    // 返されたフィールドはデフォルトのコンテンツを上書きします。フィールドが返されない場合は、デフォルトのコンテンツが使用されます。
    return {
      name: 'my-custom-api',
      success: error ? 0 : 1,
      // オプション。
      snapshots: JSON.stringify({
        params: 'page=1&size=10', // 入力パラメーター。
        response: '', // 戻り値。
        reqHeaders: '', // リクエストヘッダー。
        resHeaders: '', // レスポンスヘッダー。
      }),
      properties: {
        prop_msg: 'custom msg',
        prop_num: 1,
      },
    };
  },
});

フィルター パラメーター

フィルター パラメーターは、レポートする必要のないリソース イベントと例外イベントを除外します。

MatchOption

type MatchOption = string | RegExp | ((value: string, error?: Error) => boolean);

• string: 指定された値で始まる URL と一致します。たとえば、https://api.aliyun.com は https://api.aliyun.com/v1/resource と一致します。

• RegExp: 正規表現と URL を指定します。

• function: 関数を使用して、URL が一致するかどうかを判断します。true が返された場合、URL は一致します。例外をフィルタリングする場合、2 番目のパラメーター（Error オブジェクト）が渡されます。

入力が MatchOption[] の場合、上記の条件が順番に評価され、いずれかの条件が満たされると除外されます。

例

armsRum.init({
  pid: "your app id",
  endpoint: "your endpoint",
  filters: {
    // 例外イベントを除外する
    exception: [
      'Test error', // 'Test error' で始まるエラーメッセージをフィルタリングします。
      /^Script error\.?$/, // 正規表現を指定します。
      (msg, error) => {
        return msg.includes('example-error');
      },
    ],
    // リソースまたは API イベントを除外する
    resource: [
      'https://example.com/', // 'https://example.com/' で始まるリソースをフィルタリングします。
      /localhost/i,
      (url) => {
        return url.includes('example-resource');
      },
    ],
  },
});

properties パラメーター

RUM が提供するプロパティは、すべてのイベントに対して設定できます。

evaluateApi、sendCustom、sendException、および sendResource を使用して、イベントにプロパティを追加できます。プロパティは、そのイベントに対してのみ有効です。

グローバル プロパティとイベント プロパティは、保存時にマージされます。イベント プロパティは、グローバル プロパティよりも優先順位が高くなります。マージ時に同じキーが使用されている場合、イベント プロパティはグローバル プロパティを上書きします。マージ後のキーと値のペアの数は 20 を超えることはできません。数が 20 を超える場合、ペアはキーに基づいてソートされ、超過分は削除されます。

例

グローバルに設定されたプロパティは、レポートされるすべてのイベントにアタッチされます。

armsRum.init({
  pid: "your app id",
  endpoint: "your endpoint",
  properties: {
    prop_string: 'xx',
    prop_number: 2,
    // キーまたは値の長さが制限を超える場合、超過部分は切り捨てられます。
    more_than_50_key_limit_012345678901234567890123456789: 'yy',
    more_than_2000_value_limit: new Array(2003).join('1'),
    // 次の無効なキーと値のペアは削除されます。
    prop_null: null,
    prop_undefined: undefined,
    prop_bool: true,
  },
});

その他の パラメーター

SDK では、IP アドレスと UserAgent に基づいて解決される共通プロパティを設定できます。事前に設定されたパラメーターは、自動的に解決されたパラメーターよりも優先順位が高くなります。

上記のパラメーターの設定項目の詳細については、「共通属性」をご参照ください。

例

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

SDK API

SDK は、カスタムデータの変更とレポート、および SDK 構成の動的な変更を行うための API を提供します。

getConfig

この関数を使用して、SDK 構成を取得できます。

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: 'CustomEvnetType1',
  name: 'customEventName2',
  // オプション。
  group: 'customEventGroup3',
  value: 111.11,
  properties: {
    prop_msg: 'custom msg',
    prop_num: 1,
  },
});

sendException

カスタム例外データをレポートするには、名前とメッセージ パラメーターを指定する必要があります。

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

カスタムリソースデータをレポートするには、名前、タイプ、および期間パラメーターを指定する必要があります。

armsRum.sendResource({
  // 必須。
  name: 'getListByPage',
  message: 'success',
  duration: 800,
  // オプション。
  url: 'https://www.aliyun.com/data/getListByPage',
  properties: {
    prop_msg: 'custom msg',
    prop_num: 1,
  },
});