Dynatrace Flutter Plugin Integration Skill

Prerequisites

• Flutter SDK installed and flutter available on PATH
• An existing Flutter project with a pubspec.yaml at the project root
• A Dynatrace environment with access to Experience Vitals (to obtain applicationId and beaconUrl, or to download dynatrace.config.yaml)
• Console access to Experience Vitals → Mobile to configure app settings (Data Privacy, Enablement and Cost Control)
• dart CLI available (comes with Flutter SDK; used to run the plugin configuration script)

Work through the steps below in order, interacting with the user at each decision point. Read actual project files before suggesting changes — do not assume the current state.

Step 1 — Check for existing dynatrace.config.yaml

Before asking the user anything, check whether dynatrace.config.yaml exists at the project root.

• File exists: Read it, show the applicationId and beaconUrl, and confirm they match the target environment. If correct, run the userOptIn check below and skip to Step 3.
• File does not exist: Proceed to Step 2.

userOptIn check:

Inspect the file for userOptIn (Android) and DTXUserOptIn (iOS).

• Present on both platforms: Trust the value as-is. If true, flag Step 9. If false, skip Step 9.
• Absent from either platform: Ask the user: "Do you have User Opt-In mode enabled or disabled?" (If unsure: Experience Vitals → Mobile → [Your App] → Settings → Data Privacy.) Add the missing value to the relevant platform(s), then flag Step 9 if the final value is true.

Step 2 — Obtain dynatrace.config.yaml (only if Step 1 found no file)

Ask the user which approach they prefer:

Option A — Download from console (recommended):

1. Open their Dynatrace environment
2. Navigate to: Experience Vitals → New Frontend → Mobile
3. Enter app name and choose Flutter as the platform
4. On the Select capability and settings screen, configure monitoring features (Crash reporting, user action monitoring, Session Replay, etc.). These settings can be changed later via Experience Vitals → [App] → Settings → Enablement and Cost Control.
5. Download dynatrace.config.yaml and place it at the project root (same level as pubspec.yaml)

Once the file is in place, apply the userOptIn check from Step 1 and flag Step 9 if needed.

Option B — Provide credentials manually: Read references/config-yaml.md for the full template and conditional blocks. Collect all required values from the user before creating any files, then apply the userOptIn check and flag Step 9 if needed.

Step 3 — Add the dependency

Read pubspec.yaml first.

• Not present: Run:

  flutter pub add dynatrace_flutter_plugin
  

• Already under dependencies: No change — proceed to Step 4.
• Under dev_dependencies: Remove it from dev_dependencies, then run flutter pub add dynatrace_flutter_plugin. The plugin is required at runtime, including in release builds.

Step 4 — Fetch dependencies

If Step 3 ran flutter pub add, dependencies are already fetched — skip this step.

Otherwise run:

flutter pub get

Confirm success before continuing.

Step 5 — Run the Dynatrace configuration script

dart run dynatrace_flutter_plugin

This reads dynatrace.config.yaml and automatically configures Android Gradle and ios/Runner/Info.plist. No manual native file edits are needed.

Common mistakes to flag and correct:

• flutter pub run dynatrace_flutter_plugin — wrong, use dart run dynatrace_flutter_plugin
• Manual edits to build.gradle / build.gradle.kts or Info.plist — not needed

Step 6 — Bootstrap the SDK in main.dart

Read lib/main.dart. Replace runApp(...) with Dynatrace().start(...):

import 'package:dynatrace_flutter_plugin/dynatrace_flutter_plugin.dart';
import 'package:flutter/material.dart';

void main() {
  Dynatrace().start(const MyApp());
}

• Dynatrace().start() calls runApp internally — remove any separate runApp call
• WidgetsFlutterBinding.ensureInitialized() is not required by Dynatrace before start(), but keep it if your app needs it for other pre-start initialization (for example, plugin or platform setup)
• Do not await Dynatrace().start() itself; only use await for other app initialization that must complete before calling start()

Step 7 — Add navigation tracking

In the root MaterialApp or CupertinoApp, add DynatraceNavigationObserver() to navigatorObservers:

MaterialApp(
  navigatorObservers: [DynatraceNavigationObserver()],
  ...
)

CupertinoApp(
  navigatorObservers: [DynatraceNavigationObserver()],
  ...
)

Step 8 — Session Replay (optional)

Ask the user: "Do you want to enable Session Replay?" If they already said so, or dynatrace_flutter_plugin_replay is already in pubspec.yaml, treat it as yes. On no, continue to Step 9.

Read references/session-replay.md for the Grail check, replay package, and console capability. Remember the answer — Step 9 needs it.