import {Fragment} from 'react';
import ExternalLink from 'sentry/components/links/externalLink';
import Link from 'sentry/components/links/link';
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';
interface StepsParams {
dsn: string;
organizationSlug?: string;
projectSlug?: string;
sourcePackageRegistries?: ModuleProps['sourcePackageRegistries'];
}
// Configuration Start
const introduction = (
{tct(
"Sentry's integration with Spring supports Spring Framework 5.1.2 and above. If you're on an older version, use [legacyIntegrationLink:our legacy integration].",
{
legacyIntegrationLink: (
),
}
)}
);
export const steps = ({
dsn,
sourcePackageRegistries,
projectSlug,
organizationSlug,
}: StepsParams): LayoutProps['steps'] => [
{
type: StepType.INSTALL,
description: t(
"Install Sentry's integration with Spring using either Maven or Gradle:"
),
configurations: [
{
description: (
{tct(
'To see source context in Sentry, you have to generate an auth token by visiting the [link:Organization Auth Tokens] settings. You can then set the token as an environment variable that is used by the build plugins.',
{
link: ,
}
)}
{tct(
'The [link:Sentry Gradle Plugin] automatically installs the Sentry SDK as well as available integrations for your dependencies. Add the following to your [code:build.gradle] file:',
{
code: ,
link: (
),
}
)}
),
language: 'groovy',
code: `
buildscript {
repositories {
mavenCentral()
}
}
plugins {
id "io.sentry.jvm.gradle" version "${
sourcePackageRegistries?.isLoading
? t('\u2026loading')
: sourcePackageRegistries?.data?.['sentry.java.android.gradle-plugin']?.version ??
'3.12.0'
}"
}
sentry {
// Generates a JVM (Java, Kotlin, etc.) source bundle and uploads your source code to Sentry.
// This enables source context, allowing you to see your source
// code as part of your stack traces in Sentry.
includeSourceContext = true
org = "${organizationSlug}"
projectName = "${projectSlug}"
authToken = System.getenv("SENTRY_AUTH_TOKEN")
}
`,
},
],
},
{
description:
{t('Maven')}
,
additionalInfo: (
{tct(
"There are two variants of Sentry available for Spring. If you're using Spring 5, use [sentrySpringLink:sentry-spring]. If you're using Spring 6, use [sentrySpringJakartaLink:sentry-spring-jakarta] instead.",
{
sentrySpringLink: (
),
sentrySpringJakartaLink: (
),
}
)}
{tct(
'The [codeSentrySpring:sentry-spring] and [codeSentrySpringJakarta:sentry-spring-jakarta] libraries provide an [codeEnableSentry:@EnableSentry] annotation that registers all required Spring beans. [codeEnableSentry:@EnableSentry] can be placed on any class annotated with [configurationLink:@Configuration] including the main entry class in Spring Boot applications annotated with [springBootApplicationLink:@SpringBootApplication].',
{
codeSentrySpring: ,
codeSentrySpringJakarta: ,
codeEnableSentry: ,
configurationLink: (
),
springBootApplicationLink: (
),
}
)}
,
configurations: [
{
language: 'xml',
partialLoading: sourcePackageRegistries?.isLoading,
description: t(
'To upload your source code to Sentry so it can be shown in stack traces, use our Maven plugin.'
),
code: `
io.sentrysentry-maven-plugin${
sourcePackageRegistries?.isLoading
? t('\u2026loading')
: sourcePackageRegistries?.data?.['sentry.java.mavenplugin']?.version ?? '0.0.4'
}true${organizationSlug}${projectSlug}\${env.SENTRY_AUTH_TOKEN}generate-resourcesuploadSourceBundle
...
`,
},
],
},
],
},
{
type: StepType.VERIFY,
description: t(
'Last, create an intentional error, so you can test that everything is working:'
),
configurations: [
{
description:
Java
,
language: 'java',
code: `
import java.lang.Exception;
import io.sentry.Sentry;
try {
throw new Exception("This is a test.");
} catch (Exception e) {
Sentry.captureException(e);
}
`,
},
{
description: