import {Fragment} from 'react'; import ExternalLink from 'sentry/components/links/externalLink'; import Link from 'sentry/components/links/link'; import {StepType} from 'sentry/components/onboarding/gettingStartedDoc/step'; import type { BasePlatformOptions, Docs, DocsParams, OnboardingConfig, } from 'sentry/components/onboarding/gettingStartedDoc/types'; import {getJavaMetricsOnboarding} from 'sentry/components/onboarding/gettingStartedDoc/utils/metricsOnboarding'; import {feedbackOnboardingCrashApiJava} from 'sentry/gettingStartedDocs/java/java'; import {t, tct} from 'sentry/locale'; import {getPackageVersion} from 'sentry/utils/gettingStartedDocs/getPackageVersion'; export enum PackageManager { GRADLE = 'gradle', MAVEN = 'maven', } const platformOptions = { packageManager: { label: t('Package Manager'), items: [ { label: t('Gradle'), value: PackageManager.GRADLE, }, { label: t('Maven'), value: PackageManager.MAVEN, }, ], }, } satisfies BasePlatformOptions; type PlatformOptions = typeof platformOptions; type Params = DocsParams; const getGradleInstallSnippet = (params: Params) => ` buildscript { repositories { mavenCentral() } } plugins { id "io.sentry.jvm.gradle" version "${getPackageVersion( params, 'sentry.java.android.gradle-plugin', '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 = "${params.organization.slug}" projectName = "${params.projectSlug}" authToken = System.getenv("SENTRY_AUTH_TOKEN") }`; const getMavenInstallSnippet = (params: Params) => ` io.sentry sentry-maven-plugin ${getPackageVersion(params, 'sentry.java.maven-plugin', '0.0.4')} true true ${params.organization.slug} ${params.projectSlug} \${env.SENTRY_AUTH_TOKEN} uploadSourceBundle ... `; const getConsoleAppenderSnippet = (params: Params) => ` %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n ${params.dsn.public} `; const getLogLevelSnippet = (params: Params) => ` ${params.dsn.public} WARN DEBUG `; const getVerifyJavaSnippet = () => ` import java.lang.Exception; import io.sentry.Sentry; try { throw new Exception("This is a test."); } catch (Exception e) { Sentry.captureException(e); }`; const getVerifyKotlinSnippet = () => ` import java.lang.Exception import io.sentry.Sentry try { throw Exception("This is a test.") } catch (e: Exception) { Sentry.captureException(e) }`; const onboarding: OnboardingConfig = { introduction: () => tct( 'The sentry-logback library provides Logback support for Sentry using an [link:Appender] that sends logged exceptions to Sentry.', { link: ( ), } ), install: params => [ { type: StepType.INSTALL, description: t( "Install Sentry's integration with Logback using %s:", params.platformOptions.packageManager === PackageManager.GRADLE ? 'Gradle' : 'Maven' ), 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: , } ), language: 'bash', code: 'SENTRY_AUTH_TOKEN=___ORG_AUTH_TOKEN___', }, ...(params.platformOptions.packageManager === PackageManager.GRADLE ? [ { description: 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: getGradleInstallSnippet(params), }, ] : []), ...(params.platformOptions.packageManager === PackageManager.MAVEN ? [ { language: 'xml', partialLoading: params.sourcePackageRegistries?.isLoading, description: tct( 'The [link:Sentry Maven Plugin] automatically installs the Sentry SDK as well as available integrations for your dependencies. Add the following to your [code:pom.xml] file:', { code: , link: ( ), } ), code: getMavenInstallSnippet(params), }, ] : []), ], additionalInfo: tct( 'If you prefer to manually upload your source code to Sentry, please refer to [link:Manually Uploading Source Context].', { link: ( ), } ), }, ], configure: (params: Params) => [ { type: StepType.CONFIGURE, description: t( "Configure Sentry as soon as possible in your application's lifecycle:" ), configurations: [ { language: 'xml', description: t( 'The following example configures a ConsoleAppender that logs to standard out at the INFO level, and a SentryAppender that logs to the Sentry server at the ERROR level. This only an example of a non-Sentry appender set to a different logging threshold, similar to what you may already have in your project.' ), code: getConsoleAppenderSnippet(params), additionalInfo: tct( "You'll also need to configure your DSN (client key) if it's not already in the [code:logback.xml] configuration. Learn more in [link:our documentation for DSN configuration].", { code: , link: ( ), } ), }, { description: tct( "Next, you'll need to set your log levels, as illustrated here. You can learn more about [link:configuring log levels] in our documentation.", { link: ( ), } ), configurations: [ { language: 'xml', code: getLogLevelSnippet(params), }, ], }, ], }, ], verify: () => [ { type: StepType.VERIFY, description: t( 'Last, create an intentional error, so you can test that everything is working:' ), configurations: [ { language: 'java', code: [ { language: 'java', label: 'Java', value: 'java', code: getVerifyJavaSnippet(), }, { language: 'kotlin', label: 'Kotlin', value: 'kotlin', code: getVerifyKotlinSnippet(), }, ], }, ], additionalInfo: (

{t( "If you're new to Sentry, use the email alert to access your account and complete a product tour." )}

{t( "If you're an existing user and have disabled alerts, you won't receive this email." )}

), }, { title: t('Other build tools'), additionalInfo: tct( 'For other dependency managers see the [link:central Maven repository].', { link: ( ), } ), }, ], nextSteps: () => [ { id: 'examples', name: t('Examples'), description: t('Check out our sample applications.'), link: 'https://github.com/getsentry/sentry-java/tree/main/sentry-samples', }, ], }; const docs: Docs = { onboarding, feedbackOnboardingCrashApi: feedbackOnboardingCrashApiJava, crashReportOnboarding: feedbackOnboardingCrashApiJava, customMetricsOnboarding: getJavaMetricsOnboarding(), platformOptions, }; export default docs;