ember.tsx 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112
  1. import ExternalLink from 'sentry/components/links/externalLink';
  2. import {Layout, LayoutProps} from 'sentry/components/onboarding/gettingStartedDoc/layout';
  3. import {ModuleProps} from 'sentry/components/onboarding/gettingStartedDoc/sdkDocumentation';
  4. import {StepType} from 'sentry/components/onboarding/gettingStartedDoc/step';
  5. import {tct} from 'sentry/locale';
  6. import type {Organization, PlatformKey} from 'sentry/types';
  7. type StepProps = {
  8. newOrg: boolean;
  9. organization: Organization;
  10. platformKey: PlatformKey;
  11. projectId: string;
  12. sentryInitContent: string;
  13. };
  14. // Configuration Start
  15. const replayIntegration = `
  16. new Sentry.Replay(),
  17. `;
  18. const replayOtherConfig = `
  19. // This sets the sample rate to be 10%. You may want this to be 100% while
  20. // in development and sample at a lower rate in production.
  21. replaysSessionSampleRate: 0.1,
  22. // If the entire session is not sampled, use the below sample rate to sample
  23. // sessions when an error occurs.
  24. replaysOnErrorSampleRate: 1.0,
  25. `;
  26. export const steps = ({
  27. sentryInitContent,
  28. }: Partial<StepProps> = {}): LayoutProps['steps'] => [
  29. {
  30. type: StepType.INSTALL,
  31. description: tct(
  32. 'You need a minimum version 7.27.0 of [code:@sentry/ember] in order to use Session Replay. You do not need to install any additional packages.',
  33. {code: <code />}
  34. ),
  35. configurations: [
  36. {
  37. language: 'bash',
  38. code: [
  39. {
  40. label: 'ember-cli',
  41. value: 'ember-cli',
  42. language: 'bash',
  43. code: 'ember install @sentry/ember',
  44. },
  45. ],
  46. },
  47. ],
  48. },
  49. {
  50. type: StepType.CONFIGURE,
  51. description: tct(
  52. 'Add the following to your SDK config. There are several privacy and sampling options available, all of which can be set using the [code:integrations] constructor. Learn more about configuring Session Replay by reading the [link:configuration docs].',
  53. {
  54. code: <code />,
  55. link: (
  56. <ExternalLink href="https://docs.sentry.io/platforms/javascript/session-replay/" />
  57. ),
  58. }
  59. ),
  60. configurations: [
  61. {
  62. language: 'javascript',
  63. code: `
  64. import * as Sentry from "@sentry/ember";
  65. Sentry.init({
  66. ${sentryInitContent}
  67. });
  68. `,
  69. },
  70. ],
  71. },
  72. ];
  73. // Configuration End
  74. export function GettingStartedWithEmberReplay({
  75. dsn,
  76. organization,
  77. newOrg,
  78. platformKey,
  79. projectId,
  80. ...props
  81. }: ModuleProps) {
  82. const integrations = replayIntegration.trim();
  83. const otherConfigs = replayOtherConfig.trim();
  84. let sentryInitContent: string[] = [`dsn: "${dsn}",`];
  85. sentryInitContent = sentryInitContent.concat('integrations: [', integrations, '],');
  86. sentryInitContent = sentryInitContent.concat(otherConfigs);
  87. return (
  88. <Layout
  89. steps={steps({
  90. sentryInitContent: sentryInitContent.join('\n'),
  91. organization,
  92. newOrg,
  93. platformKey,
  94. projectId,
  95. })}
  96. platformKey={platformKey}
  97. newOrg={newOrg}
  98. hideHeader
  99. {...props}
  100. />
  101. );
  102. }
  103. export default GettingStartedWithEmberReplay;