Swiftpack.co - TelemetryDeck/SwiftClient as Swift Package

Swiftpack.co is a collection of thousands of indexed Swift packages. Search packages.
See all packages published by TelemetryDeck.
TelemetryDeck/SwiftClient 1.1.6
Swift SDK for TelemetryDeck, a privacy-conscious analytics service for apps and websites.
⭐️ 91
🕓 32 weeks ago
iOS macOS watchOS tvOS
.package(url: "https://github.com/TelemetryDeck/SwiftClient.git", from: "1.1.6")

TelemetryClient

This package allows you to send signals to TelemetryDeck from your Swift code. Sign up for a free account at telemetrydeck.com

Initialization

Init the Telemetry Manager at app startup, so it knows your App ID (you can retrieve the App ID in the Telemetry Viewer app, under App Settings)

let configuration = TelemetryManagerConfiguration(appID: "<YOUR-APP-ID>")
// optional: modify the configuration here
TelemetryManager.initialize(with: configuration)

For example, if you're building a scene based app, in the init() function for your App:

import SwiftUI
import TelemetryClient

@main
struct TelemetryTestApp: App {
    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
    
    init() {
        // Note: Do not add this code to `WindowGroup.onAppear`, which will be called 
        //       *after* your window has been initialized, and might lead to our initialization
        //       occurring too late.
        let configuration = TelemetryManagerConfiguration(appID: "<YOUR-APP-ID>")
        TelemetryManager.initialize(with: configuration)
    }
}

Then send signals like so:

TelemetryManager.send("appLaunchedRegularly")

Debug -> 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, actvivate Test Mode to see those.

If you want to manually control wether test mode is active, you can set the configuration.testMode property.

User Identifiers

Telemetry Manager will create a user identifier for you user that is specific to app installation and device. If you have a better user identifier available, such as an email address or a username, you can use that instead, by passing it on to the TelemetryManagerConfiguration (the identifier will be hashed before sending it).

configuration.defaultUser = "myuser@example.com"

You can update the configuration after TelemetryManager is already initialized.

Payload

You can also send additional payload data with each signal:

TelemetryManager.send("databaseUpdated", with: ["numberOfDatabaseEntries": "3831"])

Telemetry Manager will automatically send a base payload with these keys:

  • platform
  • systemVersion
  • appVersion
  • buildNumber
  • isSimulator
  • isTestFlight
  • isAppStore
  • modelName
  • architecture
  • operatingSystem
  • targetEnvironment

Sessions

With each Signal, the client sends a hash of your user ID as well as a session ID. This gets automatically generated when the client is initialized, so if you do nothing, you'll get a new session each time your app is started from cold storage.

On iOS, tvOS, and watchOS, the session identifier will automatically update whenever your app returns from background, or if it is launched from cold storage. On other platforms, a new identifier will be generated each time your app launches. If you'd like more fine-grained session support, write a new random session identifier into the TelemetryManagerConfiguration's sessionID property each time a new session begins.

Developing this SDK

Your PRs on TelemetryDeck's Swift Client are very much welcome. Check out the SwiftClientTester project, which provides a harness you can use to work on the library and try out new things.

GitHub

link
Stars: 91
Last commit: 1 week ago
jonrohan Something's broken? Yell at me @ptrpavlik. Praise and feedback (and money) is also welcome.

Release Notes

Version 1.1.6
32 weeks ago

This version adds a terminate method as well as the isInitialized property. Thanks to @StarLard for your contribution!

Full Changelog: https://github.com/TelemetryDeck/SwiftClient/compare/1.1.5...1.1.6

Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API | Analytics