Absturzsicherer Code: Sentry unter Android einrichten

Erfahren Sie, wie Sie Sentry für die Android-Plattform einrichten.

Tomáš Dvořáček · 4. April 2024 · 4 Min. Lesezeit

Read in English →Číst česky →

Willkommen zurück! Wie versprochen folgt hier der zweite Teil unserer Crash-Proofing-Serie. Diesmal zeigen wir Ihnen, wie Sie Sentry für die Android-Plattform einrichten, und als Bonus ein paar nützliche Extras.

Legen wir los!

Erstellen Sie die Datei sentry.properties im Root-Ordner Ihres Android-Projekts

# TODO: update this configuration for your project
defaults.project=<project_id>
defaults.org=<organisation_slug>
defaults.url=https://sentry.<organisation_slug>.io/
auth.token=<auth_token>

Ersteinrichtung im Sentry-Admin

Bevor Sie das Sentry Android SDK einbinden, müssen Sie einige Dinge erledigen.

  • Erstellen Sie in Sentry ein neues Projekt. Geben Sie ihm einen passenden Namen wie your-project-android
  • Gehen Sie dann zu Settings → Projects → Ihr neues Projekt → General Settings
  • Sie sollten den Namen Ihres Projekts sehen. Das ist Ihre project_id. Ersetzen Sie damit <project_id> in sentry.properties
  • Gehen Sie dann zu Organization settings → General Settings, kopieren Sie Ihren organisation_slug und ersetzen Sie damit <organisation_slug> in sentry.properties
  • Gehen Sie dann zu User and tokens und erstellen Sie ein neues Token. Für den Anfang können Sie ihm alle Berechtigungen geben, besser ist es aber, jede Berechtigung zu prüfen und selbst zu entscheiden, was nötig ist.
  • Kopieren Sie dann Ihr neues Auth-Token und ersetzen Sie damit <auth_token> in sentry.properties. Sentry kann ProGuard-Mapping-Dateien für Sie hochladen und braucht dafür dieses Auth-Token. Ignorieren Sie diesen Schritt, wenn ProGuard für Sie keine Rolle spielt
  • Ihre sentry.properties sollte jetzt ausgefüllt sein.
  • Gehen Sie dann zu Settings → Projects → Ihr neues Projekt → Client Key (DSN)
  • Kopieren Sie Ihren DSN-Link und speichern Sie ihn vorerst irgendwo.
  • Jetzt können Sie zu Ihrem Android-Projekt zurückkehren

Sentry zum Projekt hinzufügen

Eine vollständige Anleitung finden Sie auf dieser Seite. Sentry kann sich per Befehl selbst einrichten. Wenn Sie aber lieber manuell vorgehen oder auf Probleme stoßen, folgen Sie der Anleitung unten oder dieser Seite. Sentry gibt Ihnen außerdem einen direkten Link für die Einrichtung in Android Studio (https://sentry.io/organizations/XXX/projects/YYY/getting-started/)

  1. Fügen Sie dies in die build.gradle Ihres Hauptmoduls ein
// you can find latest version here
// https://mvnrepository.com/artifact/io.sentry/sentry-android
implementation platform('io.sentry:sentry-bom:6.30.0')
implementation('io.sentry:sentry-android') // core library
implementation('io.sentry:sentry-android-fragment') // if you use fragments or
implementation('io.sentry:sentry-compose-android') // if you use compose
  1. Öffnen Sie Ihre Application-Klasse und initialisieren Sie Sentry
override fun onCreate() {
  super.onCreate()
  SentryAndroid.init(this) { options ->
    options.environment = BuildConfig.FLAVOR + BuildConfig.BUILD_TYPE
    options.tracesSampleRate = if (BuildConfig.DEBUG) SENTRY_FULL_RATE else SENTRY_TRACES_SAMPLE_RATE
    options.sampleRate = if (BuildConfig.DEBUG) SENTRY_FULL_RATE else SENTRY_SAMPLE_RATE
  }  
}

private companion object {
  private const val SENTRY_SAMPLE_RATE = 0.25
  private const val SENTRY_TRACES_SAMPLE_RATE = 0.1
  private const val SENTRY_FULL_RATE = 1.0
}

Sehen wir uns an, was jede Zeile macht:

options.environment = BuildConfig.FLAVOR + BuildConfig.BUILD_TYPE

Diese Zeile weist dem Issue die Umgebung zu. Wenn Sie mehrere Build-Flavors wie Development und Production verwenden, können Sie anschließend leicht nach bestimmten Flavors filtern.

options.tracesSampleRate = if (BuildConfig.DEBUG) SENTRY_FULL_RATE else SENTRY_TRACES_SAMPLE_RATE
options.sampleRate = if (BuildConfig.DEBUG) SENTRY_FULL_RATE else SENTRY_SAMPLE_RATE

Diese Zeilen legen fest, wie viel Prozent der Traces geloggt werden. 100 % bedeutet, dass alles geloggt wird. In einer Produktionsumgebung ist es nicht empfehlenswert, alles zu erfassen. In der Entwicklungsumgebung dagegen ist es sinnvoll, weil Tester so Bugs finden können. In unserem Beispiel setzen wir den Wert für die Release-Version auf 10 %.

  1. Öffnen Sie die Datei AndroidManifest.xml in Ihrem Hauptmodul und fügen Sie dies ein

Wenn Sie kein CI/CD nutzen und Ihren DSN einfach fest im Code hinterlegen möchten, ersetzen Sie ${sentryDsnUrl} durch den DSN-Link, den Sie gespeichert haben.

  1. Öffnen Sie die build.gradle der App und richten Sie den DSN auch dort ein
// build.gradle
def sentryDndsUrl = System.getenv("SENTRY_DNS_URL") ?: ""

android {
  ...
  defaultConfig {
    ...
    manifestPlaceholders = [sentryDsnUrl: sentryDsnUrl]
  }
  ...
  1. Fügen Sie dem Projekt das Sentry-Gradle-Plugin hinzu
// project's build.gradle
buildscript {
  dependencies {
    classpath "io.sentry:sentry-android-gradle-plugin"
  }
  ...
}

plugins {
    id "io.sentry.android.gradle" version "3.13.0"
}

sentry {
    includeProguardMapping = true
    autoUploadProguardMapping = true
    includeDependenciesReport = true

    tracingInstrumentation {
        enabled = true

        features = [InstrumentationFeature.DATABASE, InstrumentationFeature.FILE_IO, InstrumentationFeature.COMPOSE]

        logcat {
            enabled = false
        }
    }
}

Dieser Code aktiviert das Sentry-Gradle-Plugin. Es stellt Ihnen praktische Skripte bereit, etwa zum Hochladen des aab zu Sentry samt ProGuard-Mapping-Dateien.

Gut zu wissen

Ein neues Issue jemandem zuweisen

Jedes Issue in Sentry lässt sich einer Person zuweisen, und zwar manuell oder automatisch über Regeln.

Manuelles Vorgehen
Verwaltung der automatischen Regeln

Ein Jira-Issue direkt aus Sentry erstellen

Wenn Sie die im vorherigen Artikel erwähnte Jira-Integration eingerichtet haben, können Sie in Sentry schnell und einfach Jira-Issues direkt aus dem jeweiligen Issue heraus erstellen.

Die Discover-Seite

Mit der Discover-Seite können Sie schnell Abfragen über alle gesammelten Daten ausführen, um Analysefragen zu beantworten oder mögliche Probleme mit dem Zustand Ihres Projekts zu untersuchen. Sie können vordefinierte Abfragen nutzen oder eigene erstellen, bearbeiten und löschen. Das Tool ist wirklich leistungsstark, steht aber nur im Trial- und im Business-Tarif zur Verfügung.

Plugins für Sentry

Sentry für Android bietet Plugins, mit denen Sie automatisch spezifischere Daten erfassen können. Zum Beispiel:

// support for compose
implementation 'io.sentry:sentry-compose-android:6.30.0'

// support for Room logs
implementation 'io.sentry:sentry-android-sqlite:6.30.0'

// navigation logs
implementation 'io.sentry:sentry-android-navigation:6.30.0'

// support for Apollo3 (GraphQL)
implementation 'io.sentry:sentry-apollo-3:6.30.0'

// support for Timber
implementation 'io.sentry:sentry-android-timber:6.30.0'

Einiges, etwa Android Fragments, okHttp-Events und logcat, wird ab Sentry-Version 3.1.0 bereits automatisch geloggt.

Um das zu deaktivieren, ändern Sie die Sentry-Konfiguration in der build.gradle des Projekts.

sentry {
    ...
    tracingInstrumentation {
        enabled = true
        
        // options in enum InstrumentationFeature
        // InstrumentationFeature.DATABASE
        // InstrumentationFeature.FILE_IO
        // InstrumentationFeature.OKHTTP
        // InstrumentationFeature.COMPOSE

        features = EnumSet.allOf(InstrumentationFeature) - InstrumentationFeature.DATABASE

        // enabling/disabling logcat
        logcat {
            enabled = false
        }
    }
    ...
}

OkHttp-Plugin

Wie oben erwähnt, loggt Sentry ab Version 3.1.0 OkHttp-Events automatisch, indem es Ihren finalen Bytecode verändert und den SentryOkHttpInterceptor einfügt. Dabei entstehen Breadcrumbs, die so aussehen:

Wenn Sie Sentry 3.11.0 oder neuer verwenden, fügt Sentry außerdem den SentryOkHttpEventListener ein, der noch mehr Daten aus HTTP-Requests loggt. Alles wird mit logcat geloggt:

Vielen Dank, dass Sie in den zweiten Teil unserer Serie eingetaucht sind. Wenn Sie Fragen haben, melden Sie sich gern bei uns.

Tomáš DvořáčekSenior Android Developer
Als Nächstes lesen

Mehr aus dem Blog.

Awards & recognition

Built to stand out.

GDPR compliantZero data retention
Clutch Global Fall 2023Clutch Global Spring 2024Clutch Global Fall 2024Clutch Top Web3 Development — Czech Republic 2024
Deloitte Technology Fast 50 — 2023 Central EuropeDeloitte Technology Fast 50 — Czech RepublicDeloitte Technology Fast 500 — 2023 EMEA
Second opinion

Ask someone
who isn't us.

We've pre-loaded the context.
Ask what we're good at — and what we're not.

Opens a new chat, context already written.

Sales & AI Advisory

Start with Jakub.

Bring a business problem, a process or an idea. We’ll help you find the right next step.

A short intro call is often the fastest way to see what’s worth pursuing.

Jakub DurecFrom makers to makers
Jakub DurecAI Advisory Lead

We use cookies

Privacy policy