RUM React Native の高度な構成

概要

まだ SDK をインストールしていない場合は、アプリ内セットアップ手順に従うか、React Native セットアップドキュメントを参照してください。

Jest を使ったテスト

'@datadog/mobile-react-native' を使用したアプリのテストでは、テスト環境に Native Modules が存在しないため、余分なステップを完了する必要があるかもしれません。

Datadog は '@datadog/mobile-react-native' パッケージのモックを提供しています。Jest で使用するには、Jest のセットアップファイルに以下を追加してください。

jest.mock('@datadog/mobile-react-native', () => {
    return require('@datadog/mobile-react-native/jest/mock');
});

DatadogProvider コンポーネントで SDK を初期化すると、インタラクション、エラー、リソースの自動追跡はテストでは無効になります。

すべての SDK メソッドは jest.fn() によってモック化されているので、Datadog SDK のメソッドが呼び出されたことをアサートすることができます。

import { DdLogs } from '@datadog/mobile-react-native';

describe('App', () => {
    it('calls DdLogs.debug on mount', () => {
        renderer.create(<App />);
        expect(DdLogs.debug).toHaveBeenCalledWith('app started');
    });
});

Jest 以外のテストランナーを使用する場合、テストランナー用のモックを作成する必要があります。

初期化パラメーター

SDK 初期化時の構成で、以下のパラメーターを指定することができます。

clientToken
必須
タイプ: 文字列
Datadog クライアントトークン。
env
必須
タイプ: 文字列
アプリケーションの環境 (例: prod、pre-prod、staging)。タグの構文要件に従います。
applicationId
必須
種類: 文字列
RUM アプリケーションの ID。
trackInteractions
オプション
タイプ: ブール値
デフォルト: false
ユーザーアクションの自動収集を有効にします。
trackResources
オプション
タイプ: ブール値
デフォルト: false
リソースイベントの収集を可能にします。
trackErrors
オプション
タイプ: ブール値
デフォルト: false
React Native のクラッシュの収集を有効にします。
site
オプション
タイプ: 文字列
デフォルト: US1
組織の Datadog のサイトパラメーター。
serviceName
オプション
タイプ: 文字列
アプリケーションのサービス名。タグの構文要件に従います。
version
オプション
タイプ: 文字列
アプリケーションのバージョン。例: 1.2.3、6c44da20、2020.02.13。タグの構文要件に従います。
versionSuffix
オプション
タイプ: 文字列
報告されたアプリのバージョンにサフィックスを追加します。使用できる文字は、英数字と _、-、:、.、/ です。その他の特殊文字はアンダースコアに変換されます。バージョンとサフィックスの間には、自動的にダッシュ (-) が追加されます。タグの構文要件に従います。
trackFrustrations
任意
型: Boolean
デフォルト: true
ユーザーのフラストレーションを自動収集します。サポートされるのはエラータップのみです。このオプションを有効にすると自動的に trackInteractions: true となります。
nativeCrashReportEnabled
任意
型: Boolean
デフォルト: false
ネイティブプラットフォーム (iOS、Android) のクラッシュレポートを有効にします。
sampleRate
オプション - 非推奨
タイプ: 数値
デフォルト: 100
sessionSampleRate を参照してください。
sessionSampleRate
オプション
タイプ: 数値
デフォルト: 100
追跡するセッションの割合: すべてなら 100、なければ 0 です。追跡されたセッションのみが RUM イベントを送信します。
resourceTracingSamplingRate
オプション
タイプ: 数値
デフォルト: 20
トレースするリクエストの割合: すべてなら 100、なければ 0 です。詳細は、RUM とトレースの接続を参照してください。
verbosity
オプション
タイプ: SdkVerbosity
デフォルト: undefined
内部 SDK のロギングに使用する Verbosity。SDK の実装をデバッグするには、SdkVerbosity.DEBUG に設定します。
nativeViewTracking
オプション
タイプ: ブール値
デフォルト: false
ネイティブビューの追跡を有効にします。ネイティブビューに依存するカスタムナビゲーションシステムを使用する場合は、true に設定します。
nativeInteractionTracking
オプション
タイプ: ブール値
デフォルト: false
ネイティブインタラクションの追跡を有効にします。ネイティブ画面でのインタラクションを追跡したい場合は、true に設定します。
firstPartyHosts
オプション
タイプ: リスト
デフォルト: []
トレーシングを有効にするバックエンドホストのリスト。詳細は、RUM とトレースの接続を参照してください。
telemetrySampleRate
オプション
タイプ: 数値
デフォルト: 20
SDK の実行に関するテレメトリーデータ (エラーやデバッグログなど) は、潜在的な問題を検出して解決するために、Datadog に送信されます。このオプションを 0 に設定すると、テレメトリー収集がオプトアウトされます。
longTaskThresholdMs
オプション
タイプ: 数値 | false
デフォルト: 0
javascript のロングタスク報告のしきい値 (ミリ秒単位)。0 または false に設定すると、javascript のロングタスクの報告が無効になります。100 未満の値は 100 に引き上げられます。5000 以上の値は 5000 に下げられます。
nativeLongTaskThresholdMs
オプション
タイプ: 数値 | false
デフォルト: 200
ネイティブロングタスク報告のしきい値 (ミリ秒単位)。0 または false に設定すると、javascript のロングタスクの報告が無効になります。100 未満の値は 100 に引き上げられます。5000 以上の値は 5000 に下げられます。
vitalsUpdateFrequency
オプション
タイプ: VitalsUpdateFrequency
デフォルト: VitalsUpdateFrequency.AVERAGE
モバイルバイタルを収集する際の好ましい頻度を設定します。
uploadFrequency
オプション
タイプ: UploadFrequency
デフォルト: UploadFrequency.AVERAGE
データのバッチをアップロードする際の好ましい頻度を設定します。
batchSize
オプション
タイプ: BatchSize
デフォルト: BatchSize.MEDIUM
Datadog サーバーにアップロードする前にデータをまとめてバッチ処理する際の Datadog SDK のポリシーを定義します。小さなバッチは、より小さいがより多くのネットワークリクエストを意味し、大きなバッチは、より少ないがより大きなネットワークリクエストを意味します。
trackBackgroundEvents
オプション
タイプ: ブール値
デフォルト: false
RUM View がアクティブでない場合に、RUM イベントの追跡を有効にします。デフォルトでは、バックグランドイベントは追跡されません。この機能を有効にすると、追跡されるセッション数が増加し、請求に影響を与える可能性があります。
proxyConfig
オプション
タイプ: ProxyConfiguration
オプションのプロキシ構成。
useAccessibilityLabel
任意
型: Boolean
デフォルト: true
アクセシビリティラベルを RUM アクションの名前として使用するかどうかを制御します (デフォルトは true)。
bundleLogsWithRum
任意
型: Boolean
デフォルト: true
ログと RUM を関連付けます (デフォルトは true)。
bundleLogsWithTraces
任意
型: Boolean
デフォルト: true
ログとトレースを関連付けます (デフォルトは true)。

手動インスツルメンテーション

自動インスツルメンテーションがニーズに合わない場合は、手動で RUM イベントとログを作成できます。

ログを送信

コードをインスツルメントしてログを送信する際には、debug、info、warn、error レベルの詳細を含むことができます。

DdLogs.debug('Lorem ipsum dolor sit amet...', {});
DdLogs.info('Lorem ipsum dolor sit amet...', {});
DdLogs.warn('Lorem ipsum dolor sit amet...', {});
DdLogs.error('Lorem ipsum dolor sit amet...', {});

RUM View を手動でトラッキングする

RUM View を手動でトラッキングするには、初期化時に view key、view name、action name を指定します。必要に応じて、次の戦略のいずれかを選択できます。

DdRum.startView('<view-key>', 'View Name', {}, Date.now());
//...
DdRum.stopView('<view-key>', { custom: 42 }, Date.now());

RUM Action を手動でトラッキングする

RUM アクションを手動でトラッキングするには:

DdRum.addAction(RumActionType.TAP, 'action name', {}, Date.now());

継続的アクションをトラッキングする場合:

DdRum.startAction(RumActionType.TAP, 'action name', {}, Date.now());
//...
DdRum.stopAction({}, Date.now());

RUM Error を手動でトラッキングする

RUM エラーを手動でトラッキングするには:

DdRum.addError('<message>', ErrorSource.SOURCE, '<stacktrace>', {}, Date.now());

RUM Resource を手動でトラッキングする

RUM リソースを手動でトラッキングするには:

DdRum.startResource('<res-key>', 'GET', 'http://www.example.com/api/v1/test', {}, Date.now());
//...
DdRum.stopResource('<res-key>', 200, 'xhr', (size = 1337), {}, Date.now());

カスタムタイミングを追加する

カスタムタイミングは次のように追加できます。

DdRum.addTiming('<timing-name>');

Spans を手動で送信する

Spans を手動で送信するには:

const spanId = await DdTrace.startSpan('foo', { custom: 42 }, Date.now());
//...
DdTrace.finishSpan(spanId, { custom: 21 }, Date.now());

カスタムグローバル属性の追跡

すべての RUM イベントにユーザー情報をアタッチして、RUM セッションのより詳しい情報を入手することができます。

ユーザー情報

ユーザー特有の情報については、必要に応じてアプリで以下のコードを使用します（SDK の初期化後）。id、name、email 属性は Datadog に組み込まれていますが、アプリに適したその他の属性を追加できます。

DdSdkReactNative.setUser({
    id: '1337',
    name: 'John Smith',
    email: 'john@example.com',
    type: 'premium'
});

ユーザー情報を追加または更新したい場合は、以下のコードを使用して既存のユーザー情報を変更できます。

DdSdkReactNative.addUserExtraInfo({
    hasPaid: 'true'
});

ユーザー情報を消去したい場合 (例えば、ユーザーがサインアウトしたとき)、以下のように空のオブジェクトを渡すことで消去できます。

DdSdkReactNative.setUser({});

グローバル属性

また、グローバル属性を維持して A/B テストのコンフィギュレーション、広告キャンペーン元、カートのステータスなど指定したセッションに関する情報を追跡することも可能です。

DdSdkReactNative.setAttributes({
    profile_mode: 'wall',
    chat_enabled: true,
    campaign_origin: 'example_ad_network'
});

全データをクリア

clearAllData を使用すると、Datadog にまだ送信されていないすべてのデータをクリアできます。

DdSdkReactNative.clearAllData();

RUM イベントの変更または削除

Datadog に送信される前に RUM イベントの属性を変更したり、イベントを完全に削除したりするには、RUM React Native SDK を構成するときに Event Mappers API を使用します。

const config = new DdSdkReactNativeConfiguration(
    '<CLIENT_TOKEN>',
    '<ENVIRONMENT_NAME>',
    '<RUM_APPLICATION_ID>',
    true, // ユーザー操作 (ボタンタップなど) をトラッキング
    true, // XHR リソースをトラッキング
    true // エラーをトラッキング
);
config.logEventMapper = (event) => event;
config.errorEventMapper = (event) => event;
config.resourceEventMapper = (event) => event;
config.actionEventMapper = (event) => event;

各マッパーは (T) -> T? というシグネチャを持つ関数で、 T は具象的な RUM イベントの型です。これは、送信される前にイベントの一部を変更したり、イベントを完全に削除したりすることができます。

例えば、RUM のエラー message から機密情報を削除するには、カスタム redacted 関数を実装して、それを errorEventMapper で使用します。

config.errorEventMapper = (event) => {
    event.message = redacted(event.message);
    return event;
};

エラー、リソース、アクションのマッパーから null を返すと、イベントは完全に削除され、Datadog に送信されません。

イベントタイプに応じて、一部の特定のプロパティのみを変更できます。

イベントタイプ属性キー説明
LogEventlogEvent.messageログのメッセージ。
logEvent.contextログのカスタム属性。
ActionEventactionEvent.contextアクションのカスタム属性。
ErrorEventerrorEvent.messageエラーメッセージ。
errorEvent.sourceエラーのソース。
errorEvent.stacktraceエラーのスタックトレース。
errorEvent.contextエラーのカスタム属性。
errorEvent.timestampMsエラーのタイムスタンプ。
ResourceEventresourceEvent.contextリソースのカスタム属性。

イベントには、追加のコンテキストが含まれます。

イベントタイプコンテキスト属性キー説明
LogEventlogEvent.additionalInformation.userInfoDdSdkReactNative.setUser で設定されたグローバルユーザー情報を格納します。
logEvent.additionalInformation.attributesDdSdkReactNative.setAttributes で設定されたグローバル属性を格納します。
ActionEventactionEvent.actionContextアクションまたは undefined に対応する GestureResponderEvent。
actionEvent.additionalInformation.userInfoDdSdkReactNative.setUser で設定されたグローバルユーザー情報を格納します。
actionEvent.additionalInformation.attributesDdSdkReactNative.setAttributes で設定されたグローバル属性を格納します。
ErrorEventerrorEvent.additionalInformation.userInfoDdSdkReactNative.setUser で設定されたグローバルユーザー情報を格納します。
errorEvent.additionalInformation.attributesDdSdkReactNative.setAttributes で設定されたグローバル属性を格納します。
ResourceEventresourceEvent.resourceContextリソースまたは undefined に対応する XMLHttpRequest。
resourceEvent.additionalInformation.userInfoDdSdkReactNative.setUser で設定されたグローバルユーザー情報を格納します。
resourceEvent.additionalInformation.attributesDdSdkReactNative.setAttributes で設定されたグローバル属性を格納します。

RUM セッション ID の取得

RUM セッション ID はトラブルシューティングに役立ちます。たとえば、サポートリクエストやメール、バグ報告にセッション ID を添付しておくと、サポートチームが後で Datadog 上でユーザーセッションを特定できるようになります。

sessionStarted イベントを待たずに、ランタイムで RUM セッション ID にアクセスできます。

   fun getCurrentSessionId(promise: Promise) {
       datadog.getRumMonitor().getCurrentSessionId {
           promise.resolve(it)
        }
    }

リソースのタイミング

リソースの追跡では、以下のタイミングを提供します。

  • First Byte: スケジュール済みのリクエストと応答の最初のバイトの間の時間。ネイティブレベルのリクエスト準備、ネットワークレイテンシー、およびサーバーの応答準備時間が含まれます。
  • Download: 応答の受信にかかった時間。

非同期での初期化

アプリの起動時に多くのアニメーションが含まれている場合、これらのアニメーション中にコードを実行すると、一部のデバイスでアニメーションが遅延する可能性があります。Datadog React Native SDK for RUM の実行を、現在のアニメーションが全て開始された後に遅延させるには、構成で initializationMode を InitializationMode.ASYNC に設定します。

import { DatadogProvider, DatadogProviderConfiguration, InitializationMode } from '@datadog/mobile-react-native';

const datadogConfiguration = new DatadogProviderConfiguration(
    '<CLIENT_TOKEN>',
    '<ENVIRONMENT_NAME>',
    '<RUM_APPLICATION_ID>',
    true,
    true,
    true
);
datadogConfiguration.initializationMode = InitializationMode.ASYNC;

export default function App() {
    return (
        <DatadogProvider configuration={datadogConfiguration}>
            <Navigation />
        </DatadogProvider>
    );
}

これは、React Native の InteractionManager.runAfterInteractions を使って、アニメーションを遅延させます。

RUM SDK とのすべてのインタラクション (ビュー追跡、アクション、リソース追跡など) は引き続き記録され、100 イベントを上限とするキューに保持されます。

ログは記録されないので、実際の初期化の前に DdLogs メソッドを呼び出すとロギングが中断される可能性があります。

Datadog の非同期初期化の設定に問題がある場合は、弊社のサンプルアプリケーションをご確認ください。

初期化の遅延

SDK を初期化する前に待ちたい状況があるかもしれません。例えば、ユーザーのロールに応じて異なる構成を使用したい場合や、サーバーの 1 つから構成を取得する場合などです。

その場合、アプリを最初から自動インスツルメンテーション (ユーザーインタラクション、XHR リソース、エラーを自動的に収集) し、SDK を初期化する前に最大 100 の RUM およびスパンイベントを記録することが可能です。

import { DatadogProvider, DatadogProviderConfiguration } from '@datadog/mobile-react-native';

const datadogAutoInstrumentation = {
    trackErrors: true,
    trackInteractions: true,
    trackResources: true,
    firstPartyHosts: [''],
    resourceTracingSamplingRate: 100
};

const initializeApp = async () => {
    const configuration = await fetchDatadogConfiguration(); // どこかのサーバーから設定を取得
    await DatadogProvider.initialize(configuration);
};

export default function App() {
    useEffect(() => initializeApp(), []);

    return (
        <DatadogProvider configuration={datadogAutoInstrumentation}>
            <Navigation />
        </DatadogProvider>
    );
}

構成に次のキーがある場合:

import { ProxyConfig, SdkVerbosity, TrackingConsent } from '@datadog/mobile-react-native';

const configuration = {
    clientToken: '<CLIENT_TOKEN>',
    env: '<ENVIRONMENT_NAME>',
    applicationId: '<RUM_APPLICATION_ID>',
    sessionSamplingRate: 80, // オプション: RUM セッションのサンプル (ここでは、セッションの 80% が Datadog に送信されます)。デフォルト = 100%
    site: 'US1', // オプション: Datadog サイトを指定します。デフォルト = 'US1'
    verbosity: SdkVerbosity.WARN, // オプション: SDK が内部ログを出力するようにします (指定されたレベル以上)。デフォルト = undefined (ログを出力しない)
    serviceName: 'com.myapp', // オプション: 報告されたサービス名を設定します。デフォルト = Android / iOS アプリのパッケージ名 / bundleIdentifier
    nativeCrashReportEnabled: true, // オプション: ネイティブクラッシュレポートを有効にします。デフォルト = false
    version: '1.0.0', // オプション: ドキュメントで報告されたバージョンのオーバーライドを参照してください。デフォルト = Android / iOS アプリの VersionName / バージョン
    versionSuffix: 'codepush.v3', // オプション: ドキュメントで報告されたバージョンのオーバーライドを参照してください。デフォルト = undefined
    trackingConsent: TrackingConsent.GRANTED, // オプション: ユーザーが追跡の同意を与えていない場合、収集を無効にします。デフォルト = TrackingConsent.GRANTED
    nativeViewTracking: true, // オプション: ネイティブビューの追跡を有効にします。デフォルト = false
    proxyConfig: new ProxyConfig() // オプション: プロキシを経由してリクエストを送信します。デフォルト = undefined
};

ハイブリッド React Native アプリケーションのモニタリング

ハイブリッド React Native アプリケーションのモニタリングを参照してください。

参考資料

お役に立つドキュメント、リンクや記事:

dd-sdk-reactnative のソースコードソースコード more more React Native のモニタリングについてドキュメント more more ハイブリッド React Native アプリケーションのモニタリングドキュメント more more