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: ...)를 통해 애플리케이션 내에서 구성할 수도 있습니다. 두 방식은 동일한 블랙리스트 필터링 기능을 제공하며 동시에 사용할 수 있습니다. 어느 하나의 규칙이라도 매칭되면 해당 데이터는 폐기됩니다.

블랙리스트 필터링은 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의 key는 데이터 분류를 나타냅니다. 현재 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로 설정한 경우에만 데이터 동기화를 직접 수행하면 됩니다.