docs(rum/flutter): correct integration drift and document missing capabilities - #211
Closed
Fiona2016 wants to merge 1 commit into
Closed
docs(rum/flutter): correct integration drift and document missing capabilities#211Fiona2016 wants to merge 1 commit into
Fiona2016 wants to merge 1 commit into
Conversation
…abilities Audited zh/en Flutter SDK docs against fc-sdk-flutter origin/main (the FlashCat-branded release branch; origin/HEAD points at develop, which tracks upstream DataDog code). Corrections: - Install from pub.dev instead of a git source. flashcat_flutter_plugin 0.1.1, flashcat_tracking_http_client 0.1.0 and flashcat_webview_tracking 0.1.0 are all published under the flashcat.cloud verified publisher, so the "publication pending" note and the dependency_overrides workaround no longer apply. - Fix the logout snippet: setUserInfo() takes a required id, so the documented empty call does not compile. The correct API is clearUserInfo(). - Fix platform requirements. Flutter >= 3.27.0 and Dart >= 3.6.0 per pubspec, Android minSdkVersion >= 23 per build.gradle, iOS >= 13.0 and Kotlin >= 2.1.0 per the plugin README. The previous values (Flutter 3.0 / Dart 3.0 / iOS 12.0 / minSdk 21) would not build. - Bump the documented SDK version from 0.1.0 to 0.1.1. New content: - WebView integration via trackDatadogEvents, including the Android JavaScriptMode.unrestricted requirement. - DatadogClient and the HttpOverrides.global caveat for network tracking. - Account attribution, addUserExtraInfo, clearAllData and attachToBackgroundIsolate. - version / service / flavor, including the '+' -> '-' tag normalization that symbol upload depends on. - firstPartyHostsWithTracingHeaders with the TracingHeaderType options, and traceContextInjection. - Six previously undocumented RUM options (vitalUpdateFrequency, reportFlutterPerformance, initialResourceThreshold, trackNonFatalAnrs, appHangThreshold) plus the BatchSize / UploadFrequency / BatchProcessingLevel enum values. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Doc Review — 2026-07-27
Mode: audit
Scope:
rum/sdk/flutterSource ref:
fc-sdk-flutter@origin/mainFindings: 13 total — 5 high, 5 medium, 3 low (all applied)
Changes
setUserInfo()logout snippet withclearUserInfo()trackDatadogEvents, allowed hosts, Android caveat)flashcat_tracking_http_client; addedDatadogClientand theHttpOverrides.globalcaveatvitalUpdateFrequency,reportFlutterPerformance,initialResourceThreshold,trackNonFatalAnrs,appHangThreshold,traceContextInjectionaddUserExtraInfo,clearAllData,attachToBackgroundIsolate+→-tag normalizationfirstPartyHostsWithTracingHeadersand theTracingHeaderTypevaluesdatadog_tracking_http_client→flashcat_tracking_http_client; dropped thedependency_overridescaveatsiteis a required parameterBatchSize/UploadFrequency/BatchProcessingLevelenum values8 files changed (zh + en × 4 pages), +581 / −155. No new pages, so
docs.jsonis unchanged.mint broken-linkspasses.The three highest-impact fixes
flashcat.cloudverified publisher since 2026-07-06.DatadogSdk.instance.setUserInfo()was given as the logout call, butidis a required named parameter. The real API isclearUserInfo().minSdkVersion21 would fail to build against Flutter 3.27 / Dart 3.6 / iOS 13.0 /minSdkVersion23.Review checklist
Notes for follow-up (outside this PR)
packages/datadog_flutter_plugin/ios/flashcat_flutter_plugin.podspecdeclaress.platform = :ios, '12.0', while the plugin README and the pub.dev listing both say 13.0. The docs now state 13.0 (the stricter, user-facing number). Worth reconciling infc-sdk-flutter.flashcat_tracking_http_clientwas ported in2da34728, after the README alignment commit0bb5df35.origin/HEADforfc-sdk-flutterpoints atdevelop, which tracks upstream DataDog code (packages still nameddatadog_*at 3.4.0, commits authored by Datadog engineers). Any tooling that auto-detects the default branch for this repo will analyze the wrong tree — this audit pinnedorigin/maindeliberately.performance-impact.mdxwas created. web / android / ios have one; flutter and harmony do not.fc-sdk-fluttercontains no benchmark data, and writing the page would have meant inventing numbers. It needs real measurements from a human.origin/feat/rum-app-launch,origin/feat/refresh-rate-on-publish) add app-launch and refresh-rate metrics. They are not merged tomainand are excluded from this pass.🤖 Generated with Claude Code