telemetrydecksdk

Description:

telemetrydecksdk

TelemetryDeck SDK for Flutter #
This package allows your app to send signals to TelemetryDeck using the native TelemetryDeck libraries for Kotlin and iOS.
Getting started #


Obtain your TelemetryDeck App ID from the Dashboard


Follow the installing instructions on pub.dev.


Initialize the TelemetryClient:


void main() {
// ensure the platform channels are available
WidgetsFlutterBinding.ensureInitialized();
// configure and start the TelemetryClient
Telemetrydecksdk.start(
TelemetryManagerConfiguration(
appID: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
),
);

runApp(const MyApp());
}
copied to clipboard
Permission for internet access #
Sending signals requires access to the internet so the following permissions should be granted. For more information, you can check Flutter Cross-platform HTTP networking .
Android #
Change the app's AndroidManifest.xml to include:
<uses-permission android:name="android.permission.INTERNET" />
copied to clipboard
macOS #
Set the com.apple.security.network.client entitlement to true in the macos/Runner/DebugProfile.entitlements and macos/Runner/Release.entitlements files. You can also do this in Xcode by selecting the macos target, then the Signing & Capabilities tab, and checking Outgoing connections (Client) for both the Release and Debug targets of your app.
Sending signals #
Send a signal using the following method:
Telemetrydecksdk.send("signal_type")
copied to clipboard
Signals with additional attributes #
Append any number of custom attributes to a signal:
Telemetrydecksdk.send(
"signal_type",
additionalPayload: {"attributeName": "value"},
);
copied to clipboard
The Flutter SDK uses the native SDKs for Android and iOS which offer a number of built-in attributes which are submitted with every signal. You can overwrite these attributes by providing a custom value with the same key. For more information on how each value is calcualted, check the corresponding platform library:

majorMinorSystemVersion
telemetryClientVersion
isTestFlight (iOS only)
isDebug
architecture
modelName
isAppStore
appVersion
operatingSystem
systemVersion
majorSystemVersion
targetEnvironment
isSimulator (iOS only)
platform (iOS only)
buildNumber (iOS only)
locale
dartVersion
brand (Android only)

Stop sending signals #
Prevent signals from being sent using the stop method:
Telemetrydecksdk.stop()
copied to clipboard
This also prevents previously cached signals from being sent. In order to restart sending events, you will need to call the start method again.
Navigation signals #
A navigation signal is a regular TelemetryDeck signal of type TelemetryDeck.Navigation.pathChanged. Automatic navigation tracking is available using the navigate and navigateToDestination methods:
Telemetrydecksdk.navigate("screen1", "screen2");

Telemetrydecksdk.navigateToDestination("screen3");
copied to clipboard
Both methods allow for a custom clientUser to be passed as an optional parameter:
Telemetrydecksdk.navigate("screen1", "screen2",
clientUser: "custom_user");
copied to clipboard
For more information, please check this post.
Test mode #
If your app's build configuration is set to "Debug", all signals sent will be marked as testing signals. In the Telemetry Viewer app, activate Test Mode to see those.
If you want to manually control whether test mode is active, you can set the testMode field:
Telemetrydecksdk.start(
TelemetryManagerConfiguration(
appID: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
testMode: true,
),
);
copied to clipboard
Getting started with Test Mode
Custom Server #
A very small subset of our customers will want to use a custom signal ingestion server or a custom proxy server. To do so, you can pass the URL of the custom server to the TelemetryManagerConfiguration:
Telemetrydecksdk.start(
TelemetryManagerConfiguration(
appID: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
apiBaseURL: "https://nom.telemetrydeck.com",
),
);
copied to clipboard
Logging output #
By default, some logs helpful for monitoring TelemetryDeck are printed out to the console. You can enable additional logs by setting the debug field to true:
void main() {
Telemetrydecksdk.start(
TelemetryManagerConfiguration(
appID: "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
debug: true,
),
);
}
copied to clipboard