starlette.tsx 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146
  1. import ExternalLink from 'sentry/components/links/externalLink';
  2. import {StepType} from 'sentry/components/onboarding/gettingStartedDoc/step';
  3. import type {
  4. Docs,
  5. DocsParams,
  6. OnboardingConfig,
  7. } from 'sentry/components/onboarding/gettingStartedDoc/types';
  8. import {getPythonMetricsOnboarding} from 'sentry/components/onboarding/gettingStartedDoc/utils/metricsOnboarding';
  9. import replayOnboardingJsLoader from 'sentry/gettingStartedDocs/javascript/jsLoader/jsLoader';
  10. import {crashReportOnboardingPython} from 'sentry/gettingStartedDocs/python/python';
  11. import {t, tct} from 'sentry/locale';
  12. type Params = DocsParams;
  13. const getInstallSnippet = () => `pip install --upgrade 'sentry-sdk[starlette]'`;
  14. const getSdkSetupSnippet = (params: Params) => `
  15. from starlette.applications import Starlette
  16. import sentry_sdk
  17. sentry_sdk.init(
  18. dsn="${params.dsn}",${
  19. params.isPerformanceSelected
  20. ? `
  21. # Set traces_sample_rate to 1.0 to capture 100%
  22. # of transactions for performance monitoring.
  23. traces_sample_rate=1.0,`
  24. : ''
  25. }${
  26. params.isProfilingSelected
  27. ? `
  28. # Set profiles_sample_rate to 1.0 to profile 100%
  29. # of sampled transactions.
  30. # We recommend adjusting this value in production.
  31. profiles_sample_rate=1.0,`
  32. : ''
  33. }
  34. )
  35. `;
  36. const onboarding: OnboardingConfig = {
  37. introduction: () =>
  38. tct('The Starlette integration adds support for the Starlette Framework.', {
  39. link: <ExternalLink href="https://www.starlette.io/" />,
  40. }),
  41. install: (params: Params) => [
  42. {
  43. type: StepType.INSTALL,
  44. description: tct(
  45. 'Install [sentrySdkCode:sentry-sdk] from PyPI with the [sentryStarletteCode:starlette] extra:',
  46. {
  47. sentrySdkCode: <code />,
  48. sentryStarletteCode: <code />,
  49. }
  50. ),
  51. configurations: [
  52. {
  53. description: params.isProfilingSelected
  54. ? tct(
  55. 'You need a minimum version [codeVersion:1.18.0] of the [codePackage:sentry-python] SDK for the profiling feature.',
  56. {
  57. codeVersion: <code />,
  58. codePackage: <code />,
  59. }
  60. )
  61. : undefined,
  62. language: 'bash',
  63. code: getInstallSnippet(),
  64. },
  65. ],
  66. },
  67. ],
  68. configure: (params: Params) => [
  69. {
  70. type: StepType.CONFIGURE,
  71. description: tct(
  72. 'If you have the [codeStarlette:starlette] package in your dependencies, the Starlette integration will be enabled automatically when you initialize the Sentry SDK. Initialize the Sentry SDK before your app has been initialized:',
  73. {
  74. codeStarlette: <code />,
  75. }
  76. ),
  77. configurations: [
  78. {
  79. language: 'python',
  80. code: `${getSdkSetupSnippet(params)}
  81. app = Starlette(routes=[...])
  82. `,
  83. },
  84. ],
  85. },
  86. ],
  87. verify: (params: Params) => [
  88. {
  89. type: StepType.VERIFY,
  90. description: t(
  91. 'You can easily verify your Sentry installation by creating a route that triggers an error:'
  92. ),
  93. configurations: [
  94. {
  95. language: 'python',
  96. code: `
  97. from starlette.routing import Route
  98. ${getSdkSetupSnippet(params)}
  99. async def trigger_error(request):
  100. division_by_zero = 1 / 0
  101. app = Starlette(routes=[
  102. Route("/sentry-debug", trigger_error),
  103. ])
  104. `,
  105. },
  106. ],
  107. additionalInfo: (
  108. <div>
  109. <p>
  110. {tct(
  111. 'When you point your browser to [link:http://localhost:8000/sentry-debug/] a transaction in the Performance section of Sentry will be created.',
  112. {
  113. link: <ExternalLink href="http://localhost:8000/sentry-debug/" />,
  114. }
  115. )}
  116. </p>
  117. <p>
  118. {t(
  119. 'Additionally, an error event will be sent to Sentry and will be connected to the transaction.'
  120. )}
  121. </p>
  122. <p>{t('It takes a couple of moments for the data to appear in Sentry.')}</p>
  123. </div>
  124. ),
  125. },
  126. ],
  127. nextSteps: () => [],
  128. };
  129. const docs: Docs = {
  130. onboarding,
  131. replayOnboardingJsLoader,
  132. customMetricsOnboarding: getPythonMetricsOnboarding({
  133. installSnippet: getInstallSnippet(),
  134. }),
  135. crashReportOnboarding: crashReportOnboardingPython,
  136. };
  137. export default docs;