Kotlin Multiplatform

Kotlin Multiplatform lets you write code once and use it on various platforms. It makes building apps easier and more efficient by sharing common code, while still benefitting from native capabilities.

Sentry's Kotlin Multiplatform SDK builds on top of multiple Sentry SDKs, allowing developers to share code between platforms while being able to integrate Sentry's features into their applications. Installing this SDK will enable native crash reporting and automatic breadcrumbs for app lifecycle and UI events.

Prerequisites

Don't already have an account and Sentry project established? Head over to sentry.io, then return to this page.

Cocoa SDK Version Compatibility Table

Every version of our Kotlin Multiplatform SDK is compiled with a specific version of the Sentry Cocoa SDK. Use the Kotlin Multiplatform and Cocoa SDK combinations listed in the table below to ensure the best compatibility and stability.

Install

Sentry captures data by using an SDK within your application’s runtime.

To install the Kotlin Multiplatform SDK, you need to add the following to your build.gradle.kts file in your shared module:

plugins {
    kotlin("multiplatform")
    kotlin("native.cocoapods")
    // .. your other plugins
}

kotlin {
  android()
  iosX64()
  iosArm64()
  iosSimulatorArm64()

  sourceSets {
    val commonMain by getting {
      dependencies {
        implementation("io.sentry:sentry-kotlin-multiplatform:0.8.0")
      }
    }

    // Android target
    val androidMain by getting {
      dependsOn(commonMain)
    }

    // Apple targets:
    val iosMain by getting {
      dependsOn(commonMain)
    }
  }

  cocoapods {
    summary = "Some description for the Shared Module"
    homepage = "Link to the Shared Module homepage"
    ios.deploymentTarget = "14.1"
    podfile = project.file("../iosApp/Podfile")
    // Make sure you use the proper version according to our Cocoa SDK Version Compatibility Table.
    pod("Sentry") {
      version = "~> 8.25"
      linkOnly = true
      extraOpts += listOf("-compiler-option", "-fmodules")
    }
    framework {
      baseName = "shared"
    }
  }
}

Configure

Configuration should happen as early as possible in your application's lifecycle.

import io.sentry.kotlin.multiplatform.Sentry

Sentry.init { ->
  options.dsn = "https://examplePublicKey@o0.ingest.sentry.io/0"
}

Verify

This snippet includes an intentional error, so you can test that everything is working as soon as you set it up.

import io.sentry.kotlin.multiplatform.Sentry

fun captureError() {
  try {
    throw Exception("This is a test.")
  } catch (e: Exception) {
    Sentry.captureException(e)
  }
}

To view and resolve the recorded error, log into sentry.io and open your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved.

Supported Platforms

The table below lists supported platforms and their corresponding presets.

Overview of Features

• Native crash reporting for Android and JVM, leveraging our Android SDK and Java SDK
• Native crash reporting for iOS, macOS, tvOS, and watchOS, leveraging our Cocoa SDK
• Automatic breadcrumbs for app lifecycle and UI events

Apple Installation Methods

Swift Package Manager (SPM)

Swift Package Manager (SPM) is a powerful tool for managing dependencies in Swift that allows developers to enjoy a more native integration experience with Xcode. If you already use SPM or prefer it over other package managers on Apple platforms, this guide will show you how to install the Kotlin Multiplatform SDK while using Swift Package Manager.

Install

In order to install the Sentry Kotlin Multiplatform SDK, you need to use Cocoapods and Swift Package Manager simultaneously which might seem unconventional at first, especially if you're accustomed to using SPM for all your dependencies. However, you can achieve a smooth integration by using the Kotlin Cocoapods plugin specifically for compiling and building the shared framework. You can then continue to manage all other dependencies with SPM as usual.

Follow the steps for our primary installation method Cocoapods to install the Sentry Kotlin Multiplatform SDK.

After you've consumed the shared framework in your application via Cocoapods, you can continue with SPM for other dependencies without disrupting your existing workflow.