full examples in repo

examples/acra-basic-java-example/build.gradle.kts

@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) 2021
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+plugins {
+ id("com.android.application")
+}
+
+android {
+ compileSdkVersion(30)
+
+ defaultConfig {
+ applicationId = "org.acra.example"
+ minSdkVersion(16)
+ targetSdkVersion(30)
+ }
+ compileOptions {
+ sourceCompatibility = JavaVersion.VERSION_1_8
+ targetCompatibility = JavaVersion.VERSION_1_8
+ }
+}
+
+dependencies {
+ val acraVersion = "5.8.1-beta11"
+ implementation("ch.acra:acra-http:$acraVersion")
+}

examples/acra-basic-java-example/src/main/AndroidManifest.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+ ~ Copyright (c) 2021
+ ~
+ ~ Licensed under the Apache License, Version 2.0 (the "License");
+ ~ you may not use this file except in compliance with the License.
+ ~ You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ -->
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+ package="org.acra.example">
+
+ <uses-permission android:name="android.permission.INTERNET"/>
+
+ <application android:name=".MyApplication"/>
+</manifest>

examples/acra-basic-java-example/src/main/java/org/acra/example/MyApplication.java

@@ -0,0 +1,39 @@
+/*
+ * Copyright (c) 2021
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.acra.example;
+
+import android.app.Application;
+import android.content.Context;
+import org.acra.ACRA;
+import org.acra.config.CoreConfigurationBuilder;
+import org.acra.config.HttpSenderConfigurationBuilder;
+import org.acra.data.StringFormat;
+
+public class MyApplication extends Application {
+ @Override
+ protected void attachBaseContext(Context base) {
+ super.attachBaseContext(base);
+
+ CoreConfigurationBuilder builder = new CoreConfigurationBuilder(this);
+ builder.withBuildConfigClass(BuildConfig.class)
+ .withReportFormat(StringFormat.JSON);
+ builder.getPluginConfigurationBuilder(HttpSenderConfigurationBuilder.class)
+ .withUri("https://yourserver.com/report")
+ .withEnabled(true);
+ ACRA.init(this, builder);
+ }
+}

examples/acra-basic-kotlin-example/build.gradle.kts

@@ -0,0 +1,44 @@
+/*
+ * Copyright (c) 2021
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+plugins {
+ id("com.android.application")
+ kotlin("android")
+}
+
+android {
+ compileSdkVersion(30)
+
+ defaultConfig {
+ applicationId = "org.acra.example"
+ minSdkVersion(16)
+ targetSdkVersion(30)
+ }
+ compileOptions {
+ sourceCompatibility = JavaVersion.VERSION_1_8
+ targetCompatibility = JavaVersion.VERSION_1_8
+ }
+}
+
+dependencies {
+ val acraVersion = "5.8.1-beta11"
+ implementation("ch.acra:acra-http:$acraVersion")
+}
+
+tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile> {
+ kotlinOptions {
+ jvmTarget = "1.8"
+ }
+}

examples/acra-basic-kotlin-example/src/main/AndroidManifest.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+ ~ Copyright (c) 2021
+ ~
+ ~ Licensed under the Apache License, Version 2.0 (the "License");
+ ~ you may not use this file except in compliance with the License.
+ ~ You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ -->
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+ package="org.acra.example">
+
+ <uses-permission android:name="android.permission.INTERNET"/>
+
+ <application android:name=".MyApplication"/>
+</manifest>

examples/acra-basic-kotlin-example/src/main/java/org/acra/example/MyApplication.kt

@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) 2021
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.acra.example
+
+import android.app.Application
+import android.content.Context
+import org.acra.config.httpSender
+import org.acra.data.StringFormat
+import org.acra.ktx.initAcra
+
+class MyApplication : Application() {
+ override fun attachBaseContext(base: Context) {
+ super.attachBaseContext(base)
+ initAcra {
+ buildConfigClass = BuildConfig::class.java
+ reportFormat = StringFormat.JSON
+ httpSender {
+ uri = "https://yourserver.com/report"
+ }
+ }
+ }
+}

examples/build.gradle.kts

@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) 2021
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+buildscript {
+ repositories {
+ google()
+ mavenCentral()
+ }
+ dependencies {
+ classpath("com.android.tools.build:gradle:4.1.3")
+ classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:1.5.0")
+
+ }
+}
+
+subprojects {
+ repositories {
+ google()
+ mavenCentral()
+ }
+}

examples/gradle.properties

@@ -0,0 +1,16 @@
+#
+# Copyright (c) 2021
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+android.useAndroidX=true

examples/settings.gradle.kts

@@ -0,0 +1,17 @@
+/*
+ * Copyright (c) 2021
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+include("acra-basic-java-example")
+include("acra-basic-kotlin-example")

settings.gradle.kts

@@ -24,6 +24,7 @@ include("acra-toast")
 include("acra-notification")
 include("acra-limiter")
 include("acra-advanced-scheduler")
+includeBuild("examples")
 
 pluginManagement {
  repositories {

web/docs/How-to-debug.mdx

@@ -0,0 +1,31 @@
+---
+sidebar_position: 70
+title: How to Debug
+---
+import {AndroidCode} from "@theme/Code";
+
+This page describes how to capture logs for ACRA.
+
+## Gathering logs
+
+1. Enable dev logging by inserting this snippet before `ACRA.init`:
+
+<AndroidCode>
+
+```kotlin
+ACRA.DEV_LOGGING = true
+```
+
+```java
+ACRA.DEV_LOGGING = true;
+```
+
+</AndroidCode>
+
+2. Create a new logcat filter, with log tag parameter `ACRA`:
+
+import LogcatFilterImage from '@site/static/img/captures/logcat_filter.png'
+
+<img src={LogcatFilterImage} alt="logcat filter"/>
+
+3. If you want to report a bug or get help, stop your app and clear your logcat. Then start your app and do whatever you want to show, e.g. let it crash. Post all logs using the filter you created in 2.