Application Real-Time Monitoring Service:SDK 設定リファレンス

SDK 設定 (基本)

endpoint パラメーターは必須で、完全なエンドポイント URL を指定する必要があります。この URL は、アプリケーションを作成した後に Cloud Monitor 2.0 コンソールの [Real User Monitoring] > [application list] から取得できます。

import armsRum from '@arms/rum-electron';

armsRum.init({
  endpoint: '<YOUR-ENDPOINT>',
  enable: true,
  env: 'prod',
  version: '1.0.0',
});

アプリケーション設定

app オブジェクトは、Cloud Monitor 2.0 コンソールで異なるディメンションに基づいてデータをフィルタリングおよび集計するための拡張アプリケーションメタデータを提供します。

armsRum.init({
  endpoint: '<YOUR-ENDPOINT>',
  app: {
    name: 'MyElectronApp',
    version: '2.1.0',
    channel: 'stable',
    env: 'prod',
    type: 'electron',
    package: 'com.example.my-app',
    framework: 'react',
  },
});

ユーザー設定

user オブジェクトは現在のユーザーを識別し、Cloud Monitor 2.0 コンソールでユーザーレベルのトラブルシューティングを可能にします。

armsRum.init({
  endpoint: '<YOUR-ENDPOINT>',
  user: {
    name: 'test-user',
    tags: 'vip,enterprise',
  },
});

sessionConfig 設定

sessionConfig オプションは、セッションのサンプリングとライフサイクルポリシーを制御します。

sampleRate は 0～1 の数値である必要があります。値が 1 の場合はセッションの 100% をキャプチャし、0.1 の場合は 10% をキャプチャします。サンプリングレートを下げると、データ量とコストを削減できます。

armsRum.init({
  endpoint: '<YOUR-ENDPOINT>',
  sessionConfig: {
    sampleRate: 1,
    maxDuration: 4 * 60 * 60 * 1000,  // セッションは最大 4 時間継続します
    overtime: 30 * 60 * 1000,          // 非アクティブ状態が 30 分続くとセッションがタイムアウトします
  },
});

collectors 設定 (メインプロセス)

collectors オプションは、各メインプロセスのコレクターを有効または無効にします。各コレクターは、きめ細かな制御のために boolean または ICollectorConfig オブジェクトを受け取ります。

crash コレクターは Electron の crashReporter モジュールを使用して、メインプロセスとレンダラープロセスの両方でネイティブクラッシュをキャプチャし、WASM を使用したミニダンプファイルの解析に対応しています。

armsRum.init({
  endpoint: '<YOUR-ENDPOINT>',
  collectors: {
    jsError: true,
    consoleError: false,
    crash: true,
    api: {
      enable: true,
      // ICollectorConfig では、フィルターやその他のオプションをさらに設定できます
    },
    application: true,
  },
});

browserCollectors 設定 (レンダラープロセス)

browserCollectors オプションは、レンダラープロセスのブラウザ SDK に自動注入されるコレクターを設定します。各コレクターは boolean または ICollectorConfig オブジェクトを受け取ります。

armsRum.init({
  endpoint: '<YOUR-ENDPOINT>',
  autoInject: true,
  browserCollectors: {
    perf: true,
    webvitals: true,
    exception: true,
    whiteScreen: true,
    api: true,
    staticResource: true,
    click: false,       // クリックイベントの収集を無効化
    longTask: true,
  },
});

tracing 設定

tracing オプションは分散トレーシングを設定します。boolean を渡して有効または無効にするか、詳細設定のために ITracingOption オブジェクトを渡します。

propagatorTypes は複数の伝播プロトコルに対応しています。バックエンドで使用しているトレーシングシステムに基づいてプロトコルを選択してください。allowedUrls は文字列または正規表現の一致をサポートします。トレースヘッダーは一致するリクエストにのみ注入されます。

armsRum.init({
  endpoint: '<YOUR-ENDPOINT>',
  tracing: {
    enable: true,
    sample: 0.5,
    propagatorTypes: ['tracecontext', 'b3'],
    allowedUrls: [
      'https://api.example.com',
      /\/api\/v\d+\//,
    ],
    tracestate: true,
    baggage: false,
  },
});

その他の設定

// レンダラープロセスで手動で初期化します
import armsRum from '@arms/rum-electron/browser';
armsRum.init({ endpoint: '<YOUR-ENDPOINT>' });

armsRum.init({
  endpoint: '<YOUR-ENDPOINT>',
  autoInject: true,
  partition: 'persist:main',
  spaMode: 'hash',
  parseViewName: (url: string) => {
    // ページビュー名を解析するためのカスタムロジック
    const match = url.match(/\/app\/([^/?#]+)/);
    return match ? match[1] : url;
  },
  beforeReport: (bundle: any) => {
    // 変更したデータを返すと報告を継続します
    // null または undefined を返すとデータを破棄します
    console.log('beforeReport', bundle);
    return bundle;
  },
  properties: {
    department: 'engineering',
    region: 'cn-hangzhou',
  },
});

• partition オプションを使用して、カスタムの Electron セッションパーティションを指定します。BrowserWindow が partition 設定を使用している場合は、対応するセッションに対してプリロードスクリプトが正しく登録されるように、ここでも同じ値を指定する必要があります。

• spaMode の値は次のとおりです。

  • false ：SPA のルートトラッキングを無効にします。これはデフォルトの動作で、フルページロードのみをトラッキングします。

  • true または 'auto' ：ルーティングモードを自動検出します。pathname の変更よりも hash の変更を優先します。

  • 'hash' ：hash ルーティングモード (例：React HashRouter)。

  • 'history' ：History API ルーティングモード (例：React BrowserRouter)。

SDK API

init(config: IElectronConfig): Promise<ArmsRum>

import { app } from 'electron';
import armsRum from '@arms/rum-electron';

// app.ready の前に init を呼び出します
armsRum.init({
  endpoint: '<YOUR-ENDPOINT>',
  env: 'prod',
  version: '1.0.0',
});

app.whenReady().then(() => {
  // BrowserWindow インスタンスの作成などを行います
});

getConfig(): IElectronConfig

const config = armsRum.getConfig();
console.log('Current config:', config.endpoint, config.env);

// 単一のオプションを更新します
setConfig<T extends keyof IElectronConfig>(key: T, value: IElectronConfig[T]): void

// 複数のオプションを更新します
setConfig(config: Partial<IElectronConfig>): void

// 単一のオプションを更新します
armsRum.setConfig('enable', false);
armsRum.setConfig('env', 'daily');

// 複数のオプションを更新します
const config = armsRum.getConfig();
armsRum.setConfig({
  ...config,
  enable: true,
  env: 'prod',
  version: '2.0.0',
});

registerSession(partition: string): Promise<ArmsRum>

import { app, BrowserWindow } from 'electron';
import armsRum from '@arms/rum-electron';

// app.ready の前に init を呼び出します
armsRum.init({
  endpoint: '<YOUR-ENDPOINT>',
});

// 対応する BrowserWindow を作成する前に、カスタムパーティションのプリロードスクリプトを登録します
armsRum.registerSession('persist:main');

app.whenReady().then(() => {
  // このパーティションを使用するウィンドウを作成します
  const win = new BrowserWindow({
    webPreferences: {
      partition: 'persist:main',
      // ...
    },
  });
});