Quick Start for Android

1. 1

   Add the SDK to your project

   Add the Codeskop Android SDK to your app module's build.gradle file.

   Gradle (Kotlin DSL)Gradle (Groovy)

   app/build.gradle.ktsCopy

   1dependencies {2    implementation("com.codeskop.sdk:tracker-android:0.3.0")3    // Optional: OkHttp / Retrofit network capture (recommended)4    implementation("com.codeskop.sdk:tracker-okhttp:0.3.0")5}

   Latest version: 0.3.0

   Artifacts are on Maven Central, which every Android project already includes, so no extra repository is needed. Check the release notes for updates. Requires minSdk 24 or higher.
2. 2

   Initialize Codeskop

   Give the SDK your public ingest key. Pick one of the two options; both do the same thing.

   Option A: zero code. Add your key to AndroidManifest.xml. The SDK starts itself through App Startup, off the main thread, before Application.onCreate runs.

   AndroidManifest.xmlCopy

   1<application ...>2    <meta-data3        android:name="codeskop.api_key"4        android:value="cs_live_pk_YOUR_KEY" />5</application>

   Option B: in code. Use this when you need runtime configuration, such as a different key per build type.

   MyApplication.ktCopy

   1class MyApplication : Application() {2    override fun onCreate() {3        super.onCreate()4        CodeskopAndroid.init(5            this,6            CodeskopConfig(apiKey = BuildConfig.CODESKOP_KEY),7        )8    }9}

   Get your ingest key

   Create a project in the Codeskop dashboard and copy its public key. It starts with cs_live_pk_ (or cs_test_pk_ for testing). Public keys can only write events, so they're safe to ship in your app. Never put a secret key (cs_…_sk_) in an app.

   That's all that's needed for crash and ANR capture; both are on from the moment the SDK starts.

3. 3

   Identify your users

   Optional, but recommended: see which users an issue affects.

   KotlinCopy

   1// After a successful login or sign-up, use your own stable user id, never an email2Codeskop.identify(userId = user.id, traits = mapOf("plan" to user.plan))3 4// On logout5Codeskop.reset()

   Pass an ID from your own system. Codeskop never needs an email address or name. See Identify users.

4. 4

   Capture network failures

   Optional: add the OkHttp adapter to see failing requests, status codes and latency.

   NetworkModule.ktCopy

   1import com.codeskop.sdk.okhttp.codeskop2 3val client = OkHttpClient.Builder()4    .codeskop()   // failed requests + timing, one line5    .build()6 7// Retrofit picks it up automatically8val retrofit = Retrofit.Builder()9    .client(client)10    .baseUrl("https://api.example.com/")11    .build()

   No per-endpoint setup. Headers such as Authorization and Cookie are redacted before anything leaves the device. More in Network capture.

5. 5

   Verify installation

   Run your app, then send a test event to confirm everything is connected.

   KotlinCopy

   1// Anywhere in a debug build: records a handled exception, then sends it right away2Codeskop.recordException(IllegalStateException("Codeskop test event"))3lifecycleScope.launch { Codeskop.flush() }

   flush() asks the SDK to send its queue now; normally it syncs on its own in the background. Open your project in the dashboard to see the event. Events are stored on the device first, so a test run in airplane mode still shows up once the device reconnects.

   Nothing showing up?

   Check that the key is a public pk key and that your plan is active. The troubleshooting guide walks through every common cause.

Next steps