123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130 |
- import ExternalLink from 'sentry/components/links/externalLink';
- import {StepType} from 'sentry/components/onboarding/gettingStartedDoc/step';
- import {
- Docs,
- DocsParams,
- OnboardingConfig,
- } from 'sentry/components/onboarding/gettingStartedDoc/types';
- import replayOnboardingJsLoader from 'sentry/gettingStartedDocs/javascript/jsLoader/jsLoader';
- import {t, tct} from 'sentry/locale';
- type Params = DocsParams;
- const getSdkSetupSnippet = (params: Params) => `
- import sentry_sdk
- from sentry_sdk.integrations.quart import QuartIntegration
- from quart import Quart
- sentry_sdk.init(
- dsn="${params.dsn}",
- integrations=[QuartIntegration()],${
- params.isPerformanceSelected
- ? `
- # Set traces_sample_rate to 1.0 to capture 100%
- # of transactions for performance monitoring.
- traces_sample_rate=1.0,`
- : ''
- }${
- params.isProfilingSelected
- ? `
- # Set profiles_sample_rate to 1.0 to profile 100%
- # of sampled transactions.
- # We recommend adjusting this value in production.
- profiles_sample_rate=1.0,`
- : ''
- }
- )
- `;
- const onboarding: OnboardingConfig = {
- introduction: () =>
- tct('The Quart integration adds support for the [link:Quart Web Framework].', {
- link: <ExternalLink href="https://quart.palletsprojects.com/" />,
- }),
- install: () => [
- {
- type: StepType.INSTALL,
- description: tct(
- 'Install [sentrySdkCode:sentry-sdk] from PyPI with the [sentryQuartCode:quart] extra:',
- {
- sentrySdkCode: <code />,
- sentryQuartCode: <code />,
- }
- ),
- configurations: [
- {
- language: 'bash',
- code: '$ pip install --upgrade sentry-sdk[quart]',
- },
- ],
- },
- ],
- configure: (params: Params) => [
- {
- type: StepType.CONFIGURE,
- description: t(
- 'To configure the SDK, initialize it with the integration before or after your app has been initialized:'
- ),
- configurations: [
- {
- language: 'python',
- code: `
- ${getSdkSetupSnippet(params)}
- app = Quart(__name__)
- `,
- },
- ],
- },
- ],
- verify: (params: Params) => [
- {
- type: StepType.VERIFY,
- description: t(
- 'You can easily verify your Sentry installation by creating a route that triggers an error:'
- ),
- configurations: [
- {
- language: 'python',
- code: `
- ${getSdkSetupSnippet(params)}
- app = Quart(__name__)
- @app.route("/")
- async def hello():
- 1/0 # raises an error
- return {"hello": "world"}
- app.run()
- `,
- },
- ],
- additionalInfo: (
- <span>
- <p>
- {tct(
- 'When you point your browser to [link:http://localhost:5000/] a transaction in the Performance section of Sentry will be created.',
- {
- link: <ExternalLink href="http://localhost:5000/" />,
- }
- )}
- </p>
- <p>
- {t(
- 'Additionally, an error event will be sent to Sentry and will be connected to the transaction.'
- )}
- </p>
- <p>{t('It takes a couple of moments for the data to appear in Sentry.')}</p>
- </span>
- ),
- },
- ],
- nextSteps: () => [],
- };
- const docs: Docs = {
- onboarding,
- replayOnboardingJsLoader,
- };
- export default docs;
|