ADFA-4397: Migrate crash and log reporting from Sentry to GlitchTip (#1490)

Author: Daniel-ADFA

.github/workflows/analyze.yml

@@ -79,7 +79,7 @@ jobs:
           # Firebase config).  Scoped to this step so SonarCloud and other
           # third-party actions never see them.
           FIREBASE_CONSOLE_URL: ${{ secrets.FIREBASE_CONSOLE_URL }}
-          SENTRY_DSN_DEBUG: ${{ secrets.SENTRY_DSN_DEBUG }}
+          GLITCHTIP_DSN: ${{ secrets.GLITCHTIP_DSN }}
         run: |
           echo "gradle_time_start=$(date +%s)" >> $GITHUB_ENV
           flox activate -d flox/base -- ./gradlew :app:assembleV8Debug --no-daemon
@@ -104,7 +104,7 @@ jobs:
           # The Gradle build also drives Sentry/Firebase configuration during
           # the unit-test compile path.
           FIREBASE_CONSOLE_URL: ${{ secrets.FIREBASE_CONSOLE_URL }}
-          SENTRY_DSN_DEBUG: ${{ secrets.SENTRY_DSN_DEBUG }}
+          GLITCHTIP_DSN: ${{ secrets.GLITCHTIP_DSN }}
         run: flox activate -d flox/base -- ./gradlew :testing:tooling:assemble :testing:common:assemble sonarqube --info --no-build-cache -x lint --continue
 
       - name: Upload JaCoCo report

.github/workflows/debug.yml

@@ -28,7 +28,7 @@ env:
   ORG_GRADLE_PROJECT_signingInMemoryKeyId: ${{ secrets.MVN_SIGNING_KEY_ID }}
   ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.MVN_SIGNING_KEY_PASSWORD }}
   FIREBASE_CONSOLE_URL: ${{ secrets.FIREBASE_CONSOLE_URL }}
-  SENTRY_DSN_DEBUG: ${{ secrets.SENTRY_DSN_DEBUG }}
+  GLITCHTIP_DSN: ${{ secrets.GLITCHTIP_DSN }}
 
 jobs:
   check_changes:

.github/workflows/release.yml

@@ -25,10 +25,7 @@ env:
   ORG_GRADLE_PROJECT_signingInMemoryKeyId: ${{ secrets.MVN_SIGNING_KEY_ID }}
   ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.MVN_SIGNING_KEY_PASSWORD }}
   FIREBASE_CONSOLE_URL: ${{ secrets.FIREBASE_CONSOLE_URL }}
-  SENTRY_DSN_RELEASE: ${{ secrets.SENTRY_DSN_RELEASE }}
-  SENTRY_ORG: ${{ secrets.SENTRY_ORG }}
-  SENTRY_PROJECT: ${{ secrets.SENTRY_PROJECT }}
-  SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
+  GLITCHTIP_DSN: ${{ secrets.GLITCHTIP_DSN }}
 
 jobs:
   merge_stage_to_main:

app/build.gradle.kts

@@ -48,6 +48,8 @@ val props =
 		if (file.exists()) load(file.inputStream())
 	}
 
+val glitchtipDsn = props.getProperty("glitchtipDsn") ?: propOrEnv("GLITCHTIP_DSN")
+
 apply {
 	plugin(AndroidIDEAssetsPlugin::class.java)
 }
@@ -79,12 +81,10 @@ android {
 	buildTypes {
 		debug {
 			signingConfig = signingConfigs.getByName("debug")
-			manifestPlaceholders["sentryDsn"] =
-				props.getProperty("sentryDsnDebug") ?: propOrEnv("SENTRY_DSN_DEBUG")
+			manifestPlaceholders["sentryDsn"] = glitchtipDsn
 		}
 		release {
-			manifestPlaceholders["sentryDsn"] =
-				props.getProperty("sentryDsnRelease") ?: propOrEnv("SENTRY_DSN_RELEASE")
+			manifestPlaceholders["sentryDsn"] = glitchtipDsn
 		}
 	}
 
@@ -324,7 +324,7 @@ dependencies {
 	// Sentry Android SDK (core + replay for quality configuration)
 	implementation(libs.sentry.core)
 	implementation(libs.sentry.android.core)
-	implementation(libs.sentry.android.replay)
+	implementation(libs.sentry.logback)
 
 	// Firebase Analytics
 	implementation(platform(libs.firebase.bom))

app/src/main/AndroidManifest.xml

@@ -143,30 +143,14 @@
         <!-- enable the performance API by setting a sample-rate, adjust in production env -->
         <meta-data
             android:name="io.sentry.traces.sample-rate"
-            android:value="1.0" />
-        <!-- enable profiling when starting transactions, adjust in production env -->
-        <meta-data
-            android:name="io.sentry.traces.profiling.sample-rate"
-            android:value="1.0" />
+            android:value="0.0" />
         <meta-data
             android:name="io.sentry.send-default-pii"
             android:value="true" />
-        <!-- Enable profiling on app start -->
-        <meta-data
-            android:name="io.sentry.traces.profiling.start-on-app-start"
-            android:value="true" />
         <!-- Enable logs to be sent to Sentry -->
         <meta-data
             android:name="io.sentry.logs.enabled"
             android:value="true" />
-        <!-- Record session replays for 100% of errors and 10% of sessions -->
-        <meta-data
-            android:name="io.sentry.session-replay.on-error-sample-rate"
-            android:value="1.0" />
-        <meta-data
-            android:name="io.sentry.session-replay.session-sample-rate"
-            android:value="0.1" />
-
         <provider
             android:name=".provider.IDEDocumentsProvider"
             android:authorities="com.itsaky.androidide.documents"

app/src/main/java/com/itsaky/androidide/app/DeviceProtectedApplicationLoader.kt

@@ -21,7 +21,6 @@ import com.itsaky.androidide.utils.FeatureFlags
 import com.termux.shared.reflection.ReflectionUtils
 import io.github.rosemoe.sora.widget.schemes.EditorColorScheme
 import io.sentry.Sentry
-import io.sentry.SentryReplayOptions.SentryReplayQuality
 import io.sentry.android.core.SentryAndroid
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.launch
@@ -32,6 +31,13 @@ import org.koin.core.component.KoinComponent
 import org.koin.core.component.inject
 import org.slf4j.LoggerFactory
 import kotlin.system.exitProcess
+import ch.qos.logback.classic.Level
+import ch.qos.logback.classic.Logger
+import ch.qos.logback.classic.LoggerContext
+import io.sentry.logback.SentryAppender
+import io.sentry.protocol.User
+import android.os.Build
+import android.provider.Settings
 
 /**
  * @author Akash Yadav
@@ -67,16 +73,34 @@ internal object DeviceProtectedApplicationLoader :
 			),
 		)
 
-		SentryAndroid.init(app) { options ->
-			// Reduce replay quality to LOW to prevent OOM
-			// This reduces screenshot compression to 10 and bitrate to 50kbps
-			// (defaults to MEDIUM quality)
-			options.sessionReplay.quality = SentryReplayQuality.LOW
-			options.environment =
-				if (BuildConfig.DEBUG) IDEApplication.SENTRY_ENV_DEV else IDEApplication.SENTRY_ENV_PROD
-
-			// Enrich every Sentry event with app-specific diagnostic context.
-			SentryDiagnosticsContext.install(options)
+		runCatching {
+			SentryAndroid.init(app) { options ->
+				options.environment =
+					if (BuildConfig.DEBUG) IDEApplication.SENTRY_ENV_DEV else IDEApplication.SENTRY_ENV_PROD
+
+				// Enrich every Sentry event with app-specific diagnostic context.
+				SentryDiagnosticsContext.install(options)
+			}
+
+			val loggerContext = LoggerFactory.getILoggerFactory() as LoggerContext
+			val sentryLogAppender =
+				SentryAppender().apply {
+					context = loggerContext
+					setMinimumEventLevel(Level.OFF)
+					setMinimumBreadcrumbLevel(Level.INFO)
+					setMinimumLevel(Level.WARN)
+					start()
+				}
+			loggerContext.getLogger(Logger.ROOT_LOGGER_NAME).addAppender(sentryLogAppender)
+
+			Sentry.setUser(
+				User().apply {
+					id = Settings.Secure.getString(app.contentResolver, Settings.Secure.ANDROID_ID)
+					username = "${Build.MANUFACTURER} ${Build.MODEL}"
+				},
+			)
+		}.onFailure {
+			logger.error("Failed to initialize crash and log reporting", it)
 		}
 
 		ShizukuSettings.initialize()

gradle/libs.versions.toml

@@ -147,7 +147,7 @@ firebase-analytics = { module = "com.google.firebase:firebase-analytics-ktx" }
 # Sentry
 sentry-core = { module = "io.sentry:sentry", version.ref = "sentry" }
 sentry-android-core = { module = "io.sentry:sentry-android-core", version.ref = "sentry" }
-sentry-android-replay = { module = "io.sentry:sentry-android-replay", version.ref = "sentry" }
+sentry-logback = { module = "io.sentry:sentry-logback", version.ref = "sentry" }
 
 # AndroidIDE
 androidide-ts = { module = "com.itsaky.androidide.treesitter:android-tree-sitter", version.ref = "tree-sitter" }