123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132 |
- import {Fragment} from 'react';
- import styled from '@emotion/styled';
- import ExternalLink from 'sentry/components/links/externalLink';
- import List from 'sentry/components/list/';
- import ListItem from 'sentry/components/list/listItem';
- import {StepType} from 'sentry/components/onboarding/gettingStartedDoc/step';
- import {
- Docs,
- DocsParams,
- OnboardingConfig,
- } from 'sentry/components/onboarding/gettingStartedDoc/types';
- import TextCopyInput from 'sentry/components/textCopyInput';
- import {t, tct} from 'sentry/locale';
- import {space} from 'sentry/styles/space';
- import {trackAnalytics} from 'sentry/utils/analytics';
- type Params = DocsParams;
- const onboarding: OnboardingConfig = {
- install: (params: Params) => [
- {
- type: StepType.INSTALL,
- configurations: [
- {
- description: tct(
- 'Configure your app automatically with the [wizardLink:Sentry wizard].',
- {
- wizardLink: (
- <ExternalLink href="https://docs.sentry.io/platforms/javascript/guides/nextjs/#install" />
- ),
- }
- ),
- language: 'bash',
- code: `npx @sentry/wizard@latest -i nextjs`,
- },
- ],
- additionalInfo: (
- <Fragment>
- {t(
- 'The Sentry wizard will automatically patch your application to configure the Sentry SDK:'
- )}
- <List symbol="bullet">
- <ListItem>
- {tct(
- 'Create [clientCode:sentry.client.config.js] and [serverCode:sentry.server.config.js] with the default [sentryInitCode:Sentry.init].',
- {
- clientCode: <code />,
- serverCode: <code />,
- sentryInitCode: <code />,
- }
- )}
- </ListItem>
- <ListItem>
- {tct(
- 'Create or update your Next.js config [nextConfig:next.config.js] with the default Sentry configuration.',
- {
- nextConfig: <code />,
- }
- )}
- </ListItem>
- <ListItem>
- {tct(
- 'Create [sentryClircCode:.sentryclirc] and [sentryPropertiesCode:sentry.properties] files with configuration for sentry-cli (which is used when automatically uploading source maps).',
- {
- sentryClircCode: <code />,
- sentryPropertiesCode: <code />,
- }
- )}
- </ListItem>
- <ListItem>
- {tct('Add an example page to your app to verify your Sentry setup.', {
- sentryClircCode: <code />,
- })}
- </ListItem>
- </List>
- <br />
- <ManualSetupTitle>{t('Manual Setup')}</ManualSetupTitle>
- <p>
- {tct(
- 'Alternatively, you can also [manualSetupLink:set up the SDK manually].',
- {
- manualSetupLink: (
- <ExternalLink href="https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup/" />
- ),
- }
- )}
- </p>
- <br />
- <DSNText>
- <p>
- {tct(
- "If you already have the configuration for Sentry in your application, and just need this project's ([projectSlug]) DSN, you can find it below:",
- {
- projectSlug: <code>{params.projectSlug}</code>,
- }
- )}
- </p>
- </DSNText>
- {params.organization && (
- <TextCopyInput
- onCopy={() =>
- trackAnalytics('onboarding.nextjs-dsn-copied', {
- organization: params.organization,
- })
- }
- >
- {params.dsn}
- </TextCopyInput>
- )}
- </Fragment>
- ),
- },
- ],
- configure: () => [],
- verify: () => [],
- };
- const docs: Docs = {
- onboarding,
- };
- export default docs;
- const DSNText = styled('div')`
- margin-bottom: ${space(0.5)};
- `;
- const ManualSetupTitle = styled('p')`
- font-size: ${p => p.theme.fontSizeLarge};
- font-weight: bold;
- `;
|