|
@@ -0,0 +1,146 @@
|
|
|
+import ExternalLink from 'sentry/components/links/externalLink';
|
|
|
+import {Layout, LayoutProps} from 'sentry/components/onboarding/gettingStartedDoc/layout';
|
|
|
+import {ModuleProps} from 'sentry/components/onboarding/gettingStartedDoc/sdkDocumentation';
|
|
|
+import {StepType} from 'sentry/components/onboarding/gettingStartedDoc/step';
|
|
|
+import {t, tct} from 'sentry/locale';
|
|
|
+
|
|
|
+// Configuration Start
|
|
|
+export const steps = ({
|
|
|
+ dsn,
|
|
|
+}: {
|
|
|
+ dsn?: string;
|
|
|
+} = {}): LayoutProps['steps'] => [
|
|
|
+ {
|
|
|
+ type: StepType.INSTALL,
|
|
|
+ description: (
|
|
|
+ <p>
|
|
|
+ {tct(
|
|
|
+ 'Add the [sagpLink:Sentry Android Gradle plugin] to your [app:app] module:',
|
|
|
+ {
|
|
|
+ sagpLink: (
|
|
|
+ <ExternalLink href="https://docs.sentry.io/platforms/android/configuration/gradle/" />
|
|
|
+ ),
|
|
|
+ app: <code />,
|
|
|
+ }
|
|
|
+ )}
|
|
|
+ </p>
|
|
|
+ ),
|
|
|
+ configurations: [
|
|
|
+ {
|
|
|
+ language: 'groovy',
|
|
|
+ code: `
|
|
|
+plugins {
|
|
|
+ id "com.android.application" // should be in the same module
|
|
|
+ id "io.sentry.android.gradle" version "3.11.1"
|
|
|
+}
|
|
|
+ `,
|
|
|
+ },
|
|
|
+ {
|
|
|
+ description: t(
|
|
|
+ 'The plugin will automatically add the Sentry Android SDK to your app.'
|
|
|
+ ),
|
|
|
+ },
|
|
|
+ ],
|
|
|
+ },
|
|
|
+ {
|
|
|
+ type: StepType.CONFIGURE,
|
|
|
+ description: (
|
|
|
+ <p>
|
|
|
+ {tct(
|
|
|
+ 'Configuration is done via the application [manifest: AndroidManifest.xml]. Under the hood Sentry uses a [provider:ContentProvider] to initialize the SDK based on the values provided below. This way the SDK can capture important crashes and metrics right from the app start.',
|
|
|
+ {
|
|
|
+ manifest: <code />,
|
|
|
+ provider: <code />,
|
|
|
+ }
|
|
|
+ )}
|
|
|
+ </p>
|
|
|
+ ),
|
|
|
+ configurations: [
|
|
|
+ {
|
|
|
+ description: t("Here's an example config which should get you started:"),
|
|
|
+ language: 'xml',
|
|
|
+ code: `
|
|
|
+<application>
|
|
|
+ <!-- Required: set your sentry.io project identifier (DSN) -->
|
|
|
+ <meta-data android:name="io.sentry.dsn" android:value="${dsn}" />
|
|
|
+
|
|
|
+ <!-- enable automatic breadcrumbs for user interactions (clicks, swipes, scrolls) -->
|
|
|
+ <meta-data android:name="io.sentry.traces.user-interaction.enable" android:value="true" />
|
|
|
+ <!-- enable screenshot for crashes -->
|
|
|
+ <meta-data android:name="io.sentry.attach-screenshot" android:value="true" />
|
|
|
+ <!-- enable view hierarchy for crashes -->
|
|
|
+ <meta-data android:name="io.sentry.attach-view-hierarchy" android:value="true" />
|
|
|
+
|
|
|
+ <!-- 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" />
|
|
|
+</application>
|
|
|
+ `,
|
|
|
+ },
|
|
|
+ ],
|
|
|
+ },
|
|
|
+ {
|
|
|
+ type: StepType.VERIFY,
|
|
|
+ description: (
|
|
|
+ <p>
|
|
|
+ {tct(
|
|
|
+ "This snippet contains an intentional error and can be used as a test to make sure that everything's working as expected. You can add it to your app's [mainActivity: MainActivity].",
|
|
|
+ {
|
|
|
+ mainActivity: <code />,
|
|
|
+ }
|
|
|
+ )}
|
|
|
+ </p>
|
|
|
+ ),
|
|
|
+ configurations: [
|
|
|
+ {
|
|
|
+ language: 'kotlin',
|
|
|
+ code: `
|
|
|
+val breakWorld = Button(this).apply {
|
|
|
+ text = "Break the world"
|
|
|
+ setOnClickListener {
|
|
|
+ throw RuntimeException("Break the world")
|
|
|
+ }
|
|
|
+}
|
|
|
+
|
|
|
+addContentView(breakWorld, ViewGroup.LayoutParams(
|
|
|
+ ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.WRAP_CONTENT))
|
|
|
+ `,
|
|
|
+ },
|
|
|
+ ],
|
|
|
+ },
|
|
|
+];
|
|
|
+
|
|
|
+export const nextSteps = [
|
|
|
+ {
|
|
|
+ id: 'manual-configuration',
|
|
|
+ name: t('Manual Configuration'),
|
|
|
+ description: t('Customize the SDK initialization behavior.'),
|
|
|
+ link: 'https://docs.sentry.io/platforms/android/configuration/manual-init/#manual-initialization',
|
|
|
+ },
|
|
|
+ {
|
|
|
+ id: 'proguard-r8',
|
|
|
+ name: t('ProGuard/R8'),
|
|
|
+ description: t('Deobfuscate and get readable stacktraces in your Sentry errors.'),
|
|
|
+ link: 'https://docs.sentry.io/platforms/android/configuration/gradle/#proguardr8--dexguard',
|
|
|
+ },
|
|
|
+ {
|
|
|
+ id: 'jetpack-compose',
|
|
|
+ name: t('Jetpack Compose'),
|
|
|
+ description: t('Learn about our first class integration with Jetpack Compose.'),
|
|
|
+ link: 'https://docs.sentry.io/platforms/android/configuration/integrations/jetpack-compose/',
|
|
|
+ },
|
|
|
+ {
|
|
|
+ id: 'source-context',
|
|
|
+ name: t('Source Context'),
|
|
|
+ description: t('See your source code as part of your stacktraces in Sentry.'),
|
|
|
+ link: 'https://docs.sentry.io/platforms/android/enhance-errors/source-context/',
|
|
|
+ },
|
|
|
+];
|
|
|
+// Configuration End
|
|
|
+
|
|
|
+export function GettingStartedWithAndroid({dsn, ...props}: ModuleProps) {
|
|
|
+ return <Layout steps={steps({dsn})} nextSteps={nextSteps} {...props} />;
|
|
|
+}
|
|
|
+
|
|
|
+export default GettingStartedWithAndroid;
|