Kód odolný proti pádům: nastavení Sentry na Androidu

Zjistěte, jak nastavit Sentry pro platformu Android.

Tomáš Dvořáček · 4. dubna 2024 · 3 min čtení

Read in English →Auf Deutsch lesen →

Vítejte zpět! Jak jsme slíbili, přinášíme druhý díl série o kódu odolném proti pádům. Tentokrát vám ukážeme, jak nastavit Sentry pro platformu Android, a jako bonus přidáme pár věcí, které se hodí.

Jdeme na to!

Vytvořte soubor sentry.properties v kořenové složce svého androidového projektu

# 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>

Úvodní nastavení v administraci Sentry

Než začnete implementovat Sentry Android SDK, je potřeba udělat několik věcí.

  • Vytvořte v Sentry nový projekt. Dejte mu výstižný název, například your-project-android
  • Pak přejděte do Settings → Projects → váš nový projekt → General Settings
  • Měli byste vidět název svého projektu. To je vaše project_id. V souboru sentry.properties jím nahraďte <project_id>
  • Pak přejděte do Organization settings → General Settings, zkopírujte svůj organisation_slug a nahraďte jím <organisation_slug> v souboru sentry.properties
  • Pak přejděte do User and tokens a vytvořte nový token. Pro začátek mu můžete přidat všechna oprávnění, ale lepší je projít každé oprávnění a rozhodnout se, co opravdu potřebujete.
  • Pak zkopírujte svůj nový auth token a nahraďte jím <auth_token> v souboru sentry.properties. Sentry za vás umí nahrávat mapovací soubory ProGuardu a tento auth token k tomu potřebuje. Pokud ProGuard neřešíte, tento krok přeskočte
  • Soubor sentry.properties byste teď měli mít vyplněný.
  • Pak přejděte do Settings → Projects → váš nový projekt → Client Key (DSN)
  • Zkopírujte si odkaz DSN a zatím si ho někam uložte.
  • Teď se můžete vrátit do svého androidového projektu

Přidání Sentry do projektu

Kompletní návod najdete na této stránce. Sentry se umí nastavit samo jedním příkazem, ale pokud dáváte přednost ručnímu postupu nebo narazíte na potíže, řiďte se pokyny níže nebo touto stránkou. Sentry vám také dá přímý odkaz na nastavení v Android Studiu (https://sentry.io/organizations/XXX/projects/YYY/getting-started/)

  1. Do souboru build.gradle hlavního modulu přidejte toto
// 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. Otevřete svou třídu Application a inicializujte 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
}

Pojďme se podívat, co který řádek dělá:

options.environment = BuildConfig.FLAVOR + BuildConfig.BUILD_TYPE

Tento řádek přiřadí k issue prostředí. Pokud používáte několik build flavorů, například development a production, můžete pak snadno filtrovat podle konkrétního flavoru.

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

Tyto řádky nastavují, kolik procent traces se má logovat. 100 % znamená, že se loguje všechno. V produkčním prostředí se sbírat všechno nedoporučuje, ale například ve vývojovém prostředí se to hodí, protože testeři mohou najít chyby. V našem příkladu jsme pro release verzi nastavili 10 %.

  1. Otevřete soubor AndroidManifest.xml v hlavním modulu a vložte do něj toto

Pokud nechcete používat CI/CD a chcete DSN prostě napsat natvrdo, nahraďte ${sentryDsnUrl} odkazem DSN, který jste si uložili.

  1. Otevřete build.gradle aplikace a nastavte DSN i tam
// build.gradle
def sentryDndsUrl = System.getenv("SENTRY_DNS_URL") ?: ""

android {
  ...
  defaultConfig {
    ...
    manifestPlaceholders = [sentryDsnUrl: sentryDsnUrl]
  }
  ...
  1. Přidejte do projektu Sentry gradle plugin
// 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
        }
    }
}

Tento kód zapne Sentry gradle plugin. Ten vám pro pohodlí připraví skripty, například pro nahrání aab do Sentry spolu s mapovacími soubory ProGuardu.

Co se hodí vědět

Přiřazení nové issue konkrétnímu člověku

Každou issue v Sentry lze někomu přiřadit, a to buď ručně, nebo automaticky pomocí pravidel.

Ruční postup
Správa automatických pravidel

Vytvoření Jira issue přímo ze Sentry

Pokud jste nastavili integraci s Jirou zmíněnou v předchozím článku, Sentry vám umožní rychle a snadno vytvářet Jira issues přímo z dané issue.

Stránka Discover

Stránka Discover vám umožní rychle se dotazovat nad všemi nasbíranými daty, takže dokážete odpovědět na analytické otázky nebo prozkoumat možné problémy se zdravím projektu. Můžete použít předdefinované dotazy nebo vytvářet, upravovat a mazat své vlastní. Je to opravdu silný nástroj, ale je dostupný jen v tarifech Trial a Business.

Pluginy pro Sentry

Sentry pro Android nabízí pluginy, které umožňují automaticky sbírat specifičtější data. Například:

// 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'

Některé věci, jako Android Fragments, události okHttp a logcat, se od verze Sentry 3.1.0 logují automaticky.

Pokud je chcete vypnout, upravte konfiguraci Sentry v souboru build.gradle projektu.

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

Plugin OkHttp

Jak už bylo řečeno, od verze 3.1.0 Sentry automaticky loguje události OkHttp tak, že upraví váš výsledný bytecode a vloží do něj SentryOkHttpInterceptor. Vzniknou tak breadcrumbs, které vypadají takto:

Pokud používáte Sentry 3.11.0 nebo novější, Sentry vloží také SentryOkHttpEventListener, který z http požadavků zaloguje ještě víc dat. Všechno se zaloguje přes logcat:

Děkujeme, že jste se s námi ponořili do druhého dílu naší série. Pokud máte jakékoli otázky, klidně se nám ozvěte.

Tomáš DvořáčekSenior Android Developer
Další články

Další články z blogu.

Ocenění a uznání

Stavíme věci, které vyniknou.

V souladu s GDPRData neuchováváme
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
Druhý názor

Zeptejte se někoho
jiného než nás.

Kontext jsme už připravili.
Zeptejte se, v čem jsme dobří – a v čem ne.

Otevře nový chat s předvyplněným kontextem.

Obchod a AI poradenství

Začněte s Jakubem.

Přijďte s byznysovým problémem, procesem nebo nápadem. Pomůžeme vám najít správný další krok.

Krátký úvodní hovor je často nejrychlejší cesta, jak zjistit, co stojí za to řešit.

Jakub DurecOd tvůrců pro tvůrce
Jakub DurecAI Advisory Lead

Používáme cookies

Zásady ochrany osobních údajů