SDK 初期化¶

このドキュメントでは、Flutter SDK の初期化とランタイム機能に関する内容を説明します。

基本設定¶

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // ローカル環境へのデプロイ、Datakit デプロイ
  await FTMobileFlutter.sdkConfig(
    datakitUrl: datakitUrl,
  );

  // パブリック DataWay を使用
  await FTMobileFlutter.sdkConfig(
    datawayUrl: datawayUrl,
    cliToken: cliToken,
  );
}

ブラックリストフィルタリング¶

Flutter SDK 0.5.7 以降では、データがローカルキャッシュに書き込まれる前に RUM データと Log データをフィルタリングできます。この機能はデフォルトで有効です。enableDataFilter: false を指定すると SDK 側のフィルタリングを無効にできます。

ブラックリストルールは、Guance ワークスペースのブラックリストで一元的に設定でき、SDK が DataKit または DataWay から自動的に取得します。また、FTMobileFlutter.sdkConfig(dataFilters: ...) を使用してアプリ内で設定することもできます。2 つの方法はいずれも同じブラックリストフィルタリング機能に対応しており、併用できます。いずれかのルールが一致した場合、そのデータは破棄されます。

ブラックリストフィルタリングは lineDataModifier の後、ローカルキャッシュへの書き込み前に実行されます。lineDataModifier とブラックリストフィルタリングの両方を設定している場合、フィルタリングルールは変更後のデータに基づいて判定されます。

enableDataFilter は、SDK 側のルール取得とフィルタリングのみを制御します。false に設定すると、SDK は dataFilters を適用したりワークスペースのルールを取得したりしなくなります。DataKit を使用してデータを送信する場合、ワークスペースのブラックリストが DataKit 側で引き続き実行される可能性があります。

Data Filter は SDK のデータ書き込みパイプラインに作用します。ルールが多すぎる場合や正規表現が複雑すぎる場合は、データ書き込みのパフォーマンスに影響を与える可能性があります。必要なルールのみを設定することをお勧めします。

await FTMobileFlutter.sdkConfig(
  datawayUrl: datawayUrl,
  cliToken: cliToken,
  enableDataFilter: true,
  dataFilters: {
    'logging': [
      "{ source in [ 'df_rum_ios_log', 'df_rum_android_log' ] and message match [ 'timeout' ] }",
    ],
    'rum': [
      "{ resource_status match [ '5..' ] }",
    ],
  },
);

SDK は初期化時にワークスペースのブラックリストルールを直ちに取得します。以降の取得間隔はサーバーが返す pull_interval に従います。サーバーが有効な値を返さない場合、SDK はフォールバック間隔として 10 秒を使用します。pull_interval は秒数または単位付きの文字列（例: 10、30s、2m、1h）をサポートします。

ルール構文¶

Data Filter のルール構文は、ブラックリストフィルタリングルールと基本的に同じです。完全な構文の説明はブラックリストフィルタリングルールを参照してください。

dataFilters のキーはデータ分類を表します。現在 SDK がサポートしている分類は次のとおりです。

各ルールは { 条件 } で表され、いずれかのルールが一致するとその分類のデータがフィルタリングされます。ルール内では、データの tag、field フィールドと、source、measurement のデータ型識別フィールドを使用できます。

フィールド値の形式と演算子の意味については、ブラックリストフィルタリングルールのフィールド値の形式の説明と演算子の説明を参照してください。

SDK のルール文字列内のフィールド値には、配列形式の使用を推奨します。否定演算子は not in、not match をサポートし、サーバーから配信されるルールで使用される notin、notmatch、not_in とも互換性があります。

{ status in [ 'debug' ] and env not in [ 'prod' ] and message not match [ '.*error.*' ] }

ユーザー情報のバインドとアンバインド¶

使用方法¶

/// ユーザーをバインドします
///
/// [userid] ユーザー ID
/// [userName] ユーザー名
/// [userEmail] ユーザーのメールアドレス
/// [userExt] 拡張データ
static Future<void> bindRUMUserData(String userId,
    {String? userName, String? userEmail, Map<String, String>? ext})

/// ユーザーのバインドを解除します
static Future<void> unbindRUMUserData()

コード例¶

FTMobileFlutter.bindRUMUserData("flutterUser");

FTMobileFlutter.unbindRUMUserData();

ext の追加ルールについてはフィールド競合の説明を参照してください。

ランタイム機能¶

データの手動同期¶

FTMobileFlutter.flushSyncData();

autoSync: false の場合のみ、データ同期を自前で実行する必要があります。