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: (
{tct(
'Add the [sagpLink:Sentry Android Gradle plugin] to your [app:app] module:',
{
sagpLink: (
),
app:
,
}
)}
),
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: (
{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:
,
provider:
,
}
)}
),
configurations: [
{
description: t("Here's an example config which should get you started:"),
language: 'xml',
code: `
`,
},
],
},
{
type: StepType.VERIFY,
description: (
{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:
,
}
)}
),
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 ;
}
export default GettingStartedWithAndroid;