123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388 |
- 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 {PlatformOption} from 'sentry/components/onboarding/gettingStartedDoc/types';
- import {useUrlPlatformOptions} from 'sentry/components/onboarding/platformOptionsControl';
- import {t, tct} from 'sentry/locale';
- export enum PackageManager {
- GRADLE = 'gradle',
- MAVEN = 'maven',
- }
- type PlatformOptionKey = 'packageManager';
- interface StepsParams {
- dsn: string;
- packageManager: PackageManager;
- organizationSlug?: string;
- projectSlug?: string;
- sourcePackageRegistries?: ModuleProps['sourcePackageRegistries'];
- }
- // Configuration Start
- const platformOptions: Record<PlatformOptionKey, PlatformOption> = {
- packageManager: {
- label: t('Package Manager'),
- items: [
- {
- label: t('Gradle'),
- value: PackageManager.GRADLE,
- },
- {
- label: t('Maven'),
- value: PackageManager.MAVEN,
- },
- ],
- },
- };
- const introduction = (
- <p>
- {tct(
- 'The [code:sentry-log4j2] library provides [log4jLink:Log4j 2.x] support for Sentry via an [appenderLink:Appender] that sends logged exceptions to Sentry.',
- {
- log4jLink: <ExternalLink href="https://logging.apache.org/log4j/2.x//" />,
- appenderLink: (
- <ExternalLink href="https://logging.apache.org/log4j/2.x/manual/appenders.html" />
- ),
- code: <code />,
- }
- )}
- </p>
- );
- export const steps = ({
- dsn,
- sourcePackageRegistries,
- projectSlug,
- organizationSlug,
- packageManager,
- }: StepsParams): LayoutProps['steps'] => [
- {
- type: StepType.INSTALL,
- description: t(
- "Install Sentry's integration with Log4j 2.x using %s:",
- packageManager === PackageManager.GRADLE ? 'Gradle' : 'Maven'
- ),
- configurations: [
- {
- description: (
- <p>
- {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: <Link to="/settings/auth-tokens/" />,
- }
- )}
- </p>
- ),
- language: 'bash',
- code: 'SENTRY_AUTH_TOKEN=___ORG_AUTH_TOKEN___',
- },
- ...(packageManager === PackageManager.GRADLE
- ? [
- {
- description: (
- <p>
- {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: <code />,
- link: (
- <ExternalLink href="https://github.com/getsentry/sentry-android-gradle-plugin" />
- ),
- }
- )}
- </p>
- ),
- 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")
- }
- `,
- },
- ]
- : []),
- ...(packageManager === PackageManager.MAVEN
- ? [
- {
- language: 'xml',
- partialLoading: sourcePackageRegistries?.isLoading,
- description: (
- <p>
- {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: <code />,
- link: (
- <ExternalLink href="https://github.com/getsentry/sentry-maven-plugin" />
- ),
- }
- )}
- </p>
- ),
- code: `<build>
- <plugins>
- <plugin>
- <groupId>io.sentry</groupId>
- <artifactId>sentry-maven-plugin</artifactId>
- <version>${
- sourcePackageRegistries?.isLoading
- ? t('\u2026loading')
- : sourcePackageRegistries?.data?.['sentry.java.maven-plugin']?.version ??
- '0.0.4'
- }</version>
- <extensions>true</extensions>
- <configuration>
- <!-- for showing output of sentry-cli -->
- <debugSentryCli>true</debugSentryCli>
- <org>${organizationSlug}</org>
- <project>${projectSlug}</project>
- <!-- in case you're self hosting, provide the URL here -->
- <!--<url>http://localhost:8000/</url>-->
- <!-- provide your auth token via SENTRY_AUTH_TOKEN environment variable -->
- <authToken>\${env.SENTRY_AUTH_TOKEN}</authToken>
- </configuration>
- <executions>
- <execution>
- <goals>
- <!--
- 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.
- -->
- <goal>uploadSourceBundle</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
- </plugins>
- ...
- </build>`,
- },
- ]
- : []),
- ],
- additionalInfo: (
- <p>
- {tct(
- 'If you prefer to manually upload your source code to Sentry, please refer to [link:Manually Uploading Source Context].',
- {
- link: (
- <ExternalLink href="https://docs.sentry.io/platforms/java/source-context/#manually-uploading-source-context" />
- ),
- }
- )}
- </p>
- ),
- },
- {
- type: StepType.CONFIGURE,
- description: t(
- "Configure Sentry as soon as possible in your application's lifecycle:"
- ),
- configurations: [
- {
- language: 'xml',
- description: (
- <p>
- {tct(
- 'The following example using the [log4j2Code:log4j2.xml] format to configure a [sentryConsoleAppenderCode:ConsoleAppender] that logs to standard out at the INFO level, and a [sentryAppenderCode:SentryAppender] that logs to the Sentry server at the ERROR level.',
- {
- log4j2Code: <code />,
- sentryConsoleAppenderCode: <code />,
- sentryAppenderCode: <code />,
- }
- )}
- </p>
- ),
- code: `
- <?xml version="1.0" encoding="UTF-8"?>
- <Configuration status="warn" packages="org.apache.logging.log4j.core,io.sentry.log4j2">
- <Appenders>
- <Console name="Console" target="SYSTEM_OUT">
- <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
- </Console>
- <Sentry name="Sentry"
- dsn=${dsn}>
- </Appenders>
- <Loggers>
- <Root level="info">
- <AppenderRef ref="Sentry"/>
- <AppenderRef ref="Console"/>
- </Root>
- </Loggers>
- </Configuration>
- `,
- additionalInfo: (
- <p>
- {tct(
- "You'll also need to configure your DSN (client key) if it's not already in the [code:log4j2.xml] configuration. Learn more in [link:our documentation for DSN configuration].",
- {
- code: <code />,
- link: (
- <ExternalLink href="https://docs.sentry.io/platforms/java/guides/log4j2/#dsn-configuration" />
- ),
- }
- )}
- </p>
- ),
- },
- {
- description: (
- <p>
- {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: (
- <ExternalLink href="https://docs.sentry.io/platforms/java/guides/log4j2/#configure" />
- ),
- }
- )}
- </p>
- ),
- configurations: [
- {
- language: 'xml',
- code: `
- <!-- Setting minimumBreadcrumbLevel modifies the default minimum level to add breadcrumbs from INFO to DEBUG -->
- <!-- Setting minimumEventLevel the default minimum level to capture an event from ERROR to WARN -->
- <Sentry name="Sentry"
- dsn="${dsn}"
- minimumBreadcrumbLevel="DEBUG"
- minimumEventLevel="WARN"
- />
- `,
- },
- ],
- },
- ],
- },
- {
- 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: `
- import java.lang.Exception;
- import io.sentry.Sentry;
- try {
- throw new Exception("This is a test.");
- } catch (Exception e) {
- Sentry.captureException(e);
- }`,
- },
- {
- language: 'java',
- label: 'Kotlin',
- value: 'kotlin',
- code: `
- import java.lang.Exception
- import io.sentry.Sentry
- try {
- throw Exception("This is a test.")
- } catch (e: Exception) {
- Sentry.captureException(e)
- }`,
- },
- ],
- },
- ],
- additionalInfo: (
- <Fragment>
- <p>
- {t(
- "If you're new to Sentry, use the email alert to access your account and complete a product tour."
- )}
- </p>
- <p>
- {t(
- "If you're an existing user and have disabled alerts, you won't receive this email."
- )}
- </p>
- </Fragment>
- ),
- },
- ];
- export const nextSteps = [
- {
- id: 'examples',
- name: t('Examples'),
- description: t('Check out our sample applications.'),
- link: 'https://github.com/getsentry/sentry-java/tree/main/sentry-samples',
- },
- ];
- // Configuration End
- export function GettingStartedWithLog4j2({
- dsn,
- sourcePackageRegistries,
- projectSlug,
- organization,
- ...props
- }: ModuleProps) {
- const optionValues = useUrlPlatformOptions(platformOptions);
- const nextStepDocs = [...nextSteps];
- return (
- <Layout
- steps={steps({
- dsn,
- sourcePackageRegistries,
- projectSlug: projectSlug ?? '___PROJECT_SLUG___',
- organizationSlug: organization?.slug ?? '___ORG_SLUG___',
- packageManager: optionValues.packageManager as PackageManager,
- })}
- nextSteps={nextStepDocs}
- introduction={introduction}
- platformOptions={platformOptions}
- projectSlug={projectSlug}
- {...props}
- />
- );
- }
- export default GettingStartedWithLog4j2;
|