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

SDK パラメーター

ユーザーパラメーター

例

ArmsRum.init({
  pid: "your app id",
  endpoint: "your endpoint",
  user: {
    name: getYourUserName(),
    tags: getYourTags(),
  }
});

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",
  endpoint: "your endpoint",
  collectors: {
    action: false,
  }
});

EvaluateAPI パラメーター

evaluateApi 関数は、request イベントと httpRequest イベントのカスタム解析を提供します。

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

例

ArmsRum.init({
  pid: "your app id",
  endpoint: "your endpoint",
  evaluateApi: async (options, response, error) => {
    const respText = JSON.stringify(response);

    // 返されたフィールドはデフォルトのコンテンツを上書きします。フィールドが返されない場合は、デフォルトのコンテンツが使用されます。
    return {
      name: 'my-custom-api',
      success: error ? 0 : 1,
      snapshots: JSON.stringify({
        params: 'page=1&size=10', // 入力パラメーター
        response: respText.substring(0, 2000), // 戻り値
        reqHeaders: '', // リクエストヘッダー
        resHeaders: '' // レスポンスヘッダー
      })
    }
  }
});

フィルター パラメーター

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

Matchoption

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

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

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

• function: 関数を使用して、URL が一致するかどうかを判断します。true が返された場合、URL は一致します。

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

例

ArmsRum.init({
  pid: "your app id",
  endpoint: "your endpoint",
  filters: {
    // 例外イベントを除外する
    exception: [
      'Test error', // 'Test error' で始まるエラー メッセージ
      /^Script error\.?$/, // error.message と一致する正規表現
      (msg) => {
        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,
  },
});

その他の パラメーター

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

上記のフィールドの設定項目の詳細については、「共通属性」をご参照ください。

例

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

ReportConfig パラメーター

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

構成の取得

この関数は、SDK の構成を取得するために使用できます。

Setconfig

この関数は、SDK の構成を変更するために使用できます。

// 主要な設定を指定します
ArmsRum.setConfig('env', 'pre');

// 次の内容は上書きされる可能性があります
const config = ArmsRum.getConfig();
ArmsRum.setConfig({
  ...config,
  version: '1.0.0',
  env: 'pre',
});

Sendcustom

カスタム データをレポートするには、タイプ フィールドと名前フィールドを指定する必要があります。次の表は、データ レポートに関連するパラメーターについて説明しています。ビジネス セマンティクスを定義する必要があります。

ArmsRum.sendCustom({
  type: 'CustomEvnetType1',
  name: 'customEventName2',
  group: 'customEventGroup3',
  value: 111.11
});

SendException

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

ArmsRUM.sendException({
  // このパラメーターは必須です
  name: 'customErrorName',
  message: 'カスタム エラー メッセージ',
  // このパラメーターは任意です
  file: 'カスタム例外ファイル名',
  stack: 'カスタム例外 error.stack',
  line: 1,
  column: 2
});

Sendresource

カスタム リソース データをレポートするには、名前、種類、および期間フィールドを指定する必要があります。

ArmsRum.sendResource({
  // このパラメーターは必須です
  name: 'getListByPage',
  message: 'success',
  duration: 800,
  // このパラメーターは任意です
  url: 'https://www.aliyun.com/data/getListByPage',
});