動的設定とデータ送信先の動的更新¶
本記事では、React Native SDK のリモート設定、能動的な更新、およびデータ送信先の動的更新機能について説明します。
動的設定¶
前提条件¶
FTMobileConfig.remoteConfiguration = true の場合にのみ、動的設定に関する機能が有効になります。
リモート設定の更新を監視する¶
リモート設定を有効にすると、SDK が自動的にトリガーするリモート設定の更新結果を監視できます。
/**
* ネイティブ SDK が自動的にトリガーするリモート設定の更新を監視します。
* 動的設定を能動的に同期するメソッドが返す Promise の結果は、このイベントコールバックを通じて返されません。
*/
addRemoteConfigListener(
listener: (result: FTRemoteConfigResult) => void,
): EmitterSubscription;
使用例¶
FTMobileReactNative.addRemoteConfigListener((result) => {
console.log('自動リモート設定の更新結果:', result);
});
動的設定を能動的に同期する¶
FTMobileReactNative を使用して動的設定を能動的に同期します。自動更新では要件を満たせない場合、能動的に呼び出すことで更新タイミングを調整できます。
/**
* リモート設定を能動的に更新します。呼び出し頻度は FTMobileConfig.remoteConfigMiniUpdateInterval の影響を受けます。
*/
updateRemoteConfig(): Promise<FTRemoteConfigResult>;
/**
* リモート設定を能動的に更新します。グローバルの最小更新間隔設定を無視できます。
* 前回の更新からの経過時間が指定した間隔より短い場合、更新処理は実行されません。
* @param interval 最小更新間隔、単位:秒
* @param rules リモート設定のオーバーライドルール
*/
updateRemoteConfigWithMiniUpdateInterval(
interval: number,
rules?: Array<FTRemoteConfigOverrideRule>,
): Promise<FTRemoteConfigResult>;
使用例¶
// 基本的な能動同期更新(グローバルの最小間隔制限を受けます)
FTMobileReactNative.updateRemoteConfig();
const rule: FTRemoteConfigOverrideRule = {
id: 'test_rule',
match: {
customKeys: {
custom_key: 'custom_value',
vip_user_id: {
contains: 'test_user_1001',
},
},
},
override: {
sessionSamplingRate: 100,
traceSamplingRate: 100,
logSamplingRate: 100,
logLevelFilters: ['info', 'warn'],
},
};
const result = await FTMobileReactNative.updateRemoteConfigWithMiniUpdateInterval(0, [rule]);
console.log('updateRemoteConfigWithMiniUpdateInterval result ', result);
FTMobileReactNative.updateRemoteConfigWithMiniUpdateInterval(0, null);
customKeys の値が通常の値の場合は完全一致として処理され、値が { contains: value } の場合は包含一致として処理されます。
contains は主に、vip_user_id のような固定キーで特定のユーザーをマッチングするシーンに適しています。サーバー側の対応するフィールドが以下のいずれかの形式で返された場合、いずれもマッチングできます:
- 単一の文字列。例:
"test_user_1001" - JSON 配列。例:
["test_user_1001", "test_user_1002"] - JSON 文字列配列。例:
"[\"test_user_1001\",\"test_user_1002\"]"
サンプリングのオーバーライドフィールド¶
SDK 0.4.3 以降でサポートされます。
FTRemoteConfigOverrideRule.override は以下のパーセントフィールドをサポートします。範囲はいずれも [0,100] で、小数も使用できます。省略されたフィールドは、このルールによって変更されません。
| パーセントフィールド | 意味 | 非推奨の旧確率フィールド([0,1]) |
|---|---|---|
| sessionSamplingRate | RUM セッションのサンプリング | rumSampleRate |
| sessionOnErrorSamplingRate | エラーセッションのサンプリング | rumSessionOnErrorSampleRate |
| traceSamplingRate | トレースのサンプリング | traceSampleRate |
| logSamplingRate | ログのサンプリング | logSampleRate |
| sessionReplaySamplingRate | セッションリプレイのサンプリング | — |
| sessionReplayOnErrorSamplingRate | エラー発生時のセッションリプレイのサンプリング | — |
たとえば sessionSamplingRate: 12.5 は 12.5%、1 は 1%、100 は全件収集を表します。同じ項目で新旧両方のフィールドを設定した場合、0 を含め新しいフィールドが優先されます。上記の例では SDK 0.4.3 以降でサポートされるフィールドを使用しています。旧バージョンでは引き続き対応する確率フィールドを使用してください。旧確率フィールドは SDK 0.4.3 以降で非推奨となり、互換性のために残されています。サーバー側から配信可能なサンプリングフィールドについてはリモート設定フィールドを参照してください。上表の — は、オーバーライドルールに該当する旧フィールドが提供されていないことを示します。
データ送信先の動的更新¶
FTMobileReactNative を使用して、SDK の実行中にデータ送信先を動的に切り替えます。設定が成功すると、以降のデータは新しいアドレスへ引き続きアップロードされます。
SDK 0.4.1 以降でデータ送信先の動的更新をサポートします。
setDatakitURLとsetDatawayURLはどちらか一方を使用します。setDatawayURLを使用する場合は、新しいclientTokenも同時に渡す必要があります。
ユースケース¶
実行時にデータ送信先を切り替える¶
初期化時にデータ送信先が設定済みで、アプリの実行中にデータ受信先を変更する必要がある場合は、setDatakitURL() または setDatawayURL() を呼び出してアドレスを更新できます。DataWay を使用する場合は、新しいアドレスに対応する clientToken も同時に渡す必要があります。
データ送信先の設定を遅延させる¶
SDK 0.4.3 以降でサポートされます。
FTMobileConfig では、初期化時に datakitUrl、datawayUrl、clientToken を一旦未設定のままにし、後から setDatakitURL() または setDatawayURL() で設定を補完できます。DataWay を使用する場合は clientToken も併せて指定する必要があります。このシナリオでは、SDK はまずデータ収集を実行しますが、アップロードは行いません。
その後、FTMobileReactNative.setDatakitURL(...) または FTMobileReactNative.setDatawayURL(..., ...) を呼び出してデータ送信先を動的に設定すると、SDK はローカルキャッシュの消費を開始し、データのアップロードを実行します。
注意すべき点として、アップロード先が未設定の期間も、収集されたデータはローカルキャッシュの上限による制限を受けます。キャッシュ上限は主に以下の設定に左右されます:
FTLogConfig.logCacheLimitCountFTRUMConfig.rumCacheLimitCountFTMobileConfig.enableLimitWithDbSizeに対応するデータベースキャッシュ上限
キャッシュが上限に達した場合、超過分のデータは破棄される可能性があります。そのため、このモードではできるだけ早くアップロード先を設定するか、業務シナリオに合わせてキャッシュ制限を適切に設定することを推奨します。
使用方法¶
/**
* Datakit のデータ送信先を動的に設定します。設定が成功すると、SDK は新しい Datakit アドレスへデータのアップロードを続行します。
*/
setDatakitURL(datakitUrl: string): Promise<void>;
/**
* Dataway のデータ送信先と clientToken を動的に設定します。設定が成功すると、SDK は新しい Dataway アドレスへデータのアップロードを続行します。
*/
setDatawayURL(datawayUrl: string, clientToken: string): Promise<void>;
使用例¶
await FTMobileReactNative.setDatakitURL('http://10.0.0.1:9529');
await FTMobileReactNative.setDatawayURL(
'https://open.dataway.url',
'your-client-token',
);
| メソッド名 | 型 | 必須 | 意味 |
|---|---|---|---|
| setDatakitURL | string | はい | Datakit のデータ送信先を動的に設定します。設定が成功すると、SDK は新しい Datakit アドレスへデータのアップロードを続行します。 |
| setDatawayURL | string, string | はい | Dataway のデータ送信先と clientToken を動的に設定します。設定が成功すると、SDK は新しい Dataway アドレスへデータのアップロードを続行します。 |