Product
API
Sandbox
Sign In

Kotlin Multiplatform

Sentry's Kotlin Multiplatform SDK builds on top of multiple Sentry SDKs, allowing developers to use the same codebase and share code between platforms while being able to integrate Sentry's features into their applications.

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

On this page, we get you up and running with Sentry's SDK, so that it will automatically report errors and exceptions in your application.

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

Install

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

Prerequisites (Android)

Android requires disabling auto-init to not clash with the ContentProvider, which auto-initializes the Sentry Android SDK. To do so, add the following to the AndroidManifest.xml file under your androidMain source set:

Copied
<application>
    <meta-data android:name="io.sentry.auto-init" android:value="false" />
</application>

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

shared/build.gradle.kts
Copied
repositories {
    mavenCentral()
}

kotlin {
  val commonMain by getting {
    dependencies {
      api("io.sentry:sentry-kotlin-multiplatform:{{ packages.version('sentry.kotlin.kmp', '0.0.1-alpha.2') }}")
    }
  }

  // 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")
    pod("Sentry", "~> {{ packages.version('sentry.cocoa', '8.2.0') }}")

    framework {
      baseName = "shared"
      export("io.sentry:sentry-kotlin-multiplatform:{{ packages.version('sentry.kotlin.kmp', '0.0.1-alpha.2') }}")
    }
  }
}

Configure

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

Copied
import io.sentry.kotlin.multiplatform.Sentry

// Application context is only needed for Android targets
Sentry.init(context) { ->
  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.

Copied
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.

Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) to suggesting an update ("yeah, this would be better").
Suggest an edit to this page   |  Contribute to Docs   |  Report a problem
Package:
maven:io.sentry:sentry-kotlin-multiplatform
Version:
0.2.0
Repository:
https://github.com/getsentry/sentry-kotlin-multiplatform