Android

1. 1

   Install the dependency

   Required

   Add the PostHog Android SDK to your build.gradle dependencies:

   build.gradle

   kotlinCopy

   dependencies {
       implementation("com.posthog:posthog-android:3.+")
   }

2. 2

   Configure PostHog

   Required

   Initialize PostHog in your Application class:

   SampleApp.kt

   kotlinCopy

   class SampleApp : Application() {
   
       companion object {
           const val POSTHOG_PROJECT_TOKEN = "<ph_project_token>"
           const val POSTHOG_HOST = "https://us.i.posthog.com"
       }
   
       override fun onCreate() {
           super.onCreate()
   
           // Create a PostHog Config with the given project token and host
   
   
   
   
   
   
   
   
   

3. 3

   Send events

   Recommended

   Once installed, PostHog will automatically start capturing events. You can also manually send events to test your integration:

   Kotlin

   kotlinCopy

   import com.posthog.PostHog
   
   PostHog.capture(
       event = "button_clicked",
       properties = mapOf(
           "button_name" to "signup"
       )
   )

4. 4

   Set up exception autocapture

   Recommended

   Client-side configuration only

   Support for remote configuration in the error tracking settings (opens in a new tab) requires SDK version 3.32.0 or higher.

   You can autocapture exceptions by setting the errorTrackingConfig.autoCapture argument to true when initializing the PostHog SDK.

   Kotlin

   kotlinCopy

   import com.posthog.android.PostHogAndroidConfig
   val config = PostHogAndroidConfig(
       apiKey =
   
   
   
   
   
   

5. 5

   Manually capture exceptions

   Optional

   It is also possible to manually capture exceptions using the captureException method:

   Kotlin

   kotlinCopy

   PostHog.captureException(
       exception,
       properties = additionalProperties
   )

   This is helpful if you’ve built your own error handling logic or want to capture exceptions that are handled by your application code.

6. Verify error tracking

   Recommended

   Confirm events are being sent to PostHog

   Before proceeding, let’s make sure exception events are being captured and sent to PostHog. You should see events appear in the activity feed.

   

   Check for exceptions in PostHog (opens in a new tab)

7. 6

   Upload mapping files

   Required

   Great, you’re capturing exceptions! The next step is to upload ProGuard/R8 mapping files so PostHog can deobfuscate your stack traces.

   Let’s continue to the next section.

   Upload mapping files (opens in a new tab)

Still have questions?

Ask PostHog AI

Was this page useful?

HelpfulCould be better

When enabled, this automatically captures $exception events when errors are thrown by wrapping the Thread.UncaughtExceptionHandler listener.

Planned features

We currently don’t support source code context (opens in a new tab) associated with an exception.

These features will be added in a future release.