falcon.tsx 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141
  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[falcon]'`;
  14. const getSdkSetupSnippet = (params: Params) => `
  15. import falcon
  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 Falcon integration adds support for the [link:Falcon Web Framework].', {
  39. link: <ExternalLink href="https://falconframework.org/" />,
  40. }),
  41. install: () => [
  42. {
  43. type: StepType.INSTALL,
  44. description: tct(
  45. 'Install [sentrySdkCode:sentry-sdk] from PyPI with the [sentryFalconCode:falcon] extra:',
  46. {
  47. sentrySdkCode: <code />,
  48. sentryFalconCode: <code />,
  49. }
  50. ),
  51. configurations: [
  52. {
  53. language: 'bash',
  54. code: getInstallSnippet(),
  55. },
  56. ],
  57. },
  58. ],
  59. configure: (params: Params) => [
  60. {
  61. type: StepType.CONFIGURE,
  62. description: tct(
  63. 'If you have the [codeFalcon:falcon] package in your dependencies, the Falcon integration will be enabled automatically when you initialize the Sentry SDK. Initialize the Sentry SDK before your app has been initialized:',
  64. {
  65. codeFalcon: <code />,
  66. }
  67. ),
  68. configurations: [
  69. {
  70. language: 'python',
  71. code: `
  72. ${getSdkSetupSnippet(params)}
  73. api = falcon.API()
  74. `,
  75. },
  76. ],
  77. },
  78. ],
  79. verify: (params: Params) => [
  80. {
  81. type: StepType.VERIFY,
  82. description: t(
  83. 'To verify that everything is working, trigger an error on purpose:'
  84. ),
  85. configurations: [
  86. {
  87. language: 'python',
  88. code: `
  89. ${getSdkSetupSnippet(params)}
  90. class HelloWorldResource:
  91. def on_get(self, req, resp):
  92. message = {
  93. 'hello': "world",
  94. }
  95. 1 / 0 # raises an error
  96. resp.media = message
  97. app = falcon.App()
  98. app.add_route('/', HelloWorldResource())
  99. `,
  100. },
  101. ],
  102. additionalInfo: (
  103. <div>
  104. <p>
  105. {tct(
  106. 'When you point your browser to [link:http://localhost:8000/] a transaction in the Performance section of Sentry will be created.',
  107. {
  108. link: <ExternalLink href="http://localhost:8000/" />,
  109. }
  110. )}
  111. </p>
  112. <p>
  113. {t(
  114. 'Additionally, an error event will be sent to Sentry and will be connected to the transaction.'
  115. )}
  116. </p>
  117. <p>{t('It takes a couple of moments for the data to appear in Sentry.')}</p>
  118. </div>
  119. ),
  120. },
  121. ],
  122. nextSteps: () => [],
  123. };
  124. const docs: Docs = {
  125. onboarding,
  126. replayOnboardingJsLoader,
  127. customMetricsOnboarding: getPythonMetricsOnboarding({
  128. installSnippet: getInstallSnippet(),
  129. }),
  130. crashReportOnboarding: crashReportOnboardingPython,
  131. };
  132. export default docs;