add node snippet

Author: chargome

static/app/gettingStartedDocs/node/node/index.tsx

@@ -8,6 +8,7 @@ import {agentMonitoring} from './agentMonitoring';
 import {crashReport} from './crashReport';
 import {logs} from './logs';
 import {mcp} from './mcp';
+import {metrics} from './metrics';
 import {onboarding} from './onboarding';
 import {performance} from './performance';
 import {profiling} from './profiling';
@@ -20,6 +21,7 @@ const docs: Docs = {
   feedbackOnboardingJsLoader,
   profilingOnboarding: profiling,
   logsOnboarding: logs,
+  metricsOnboarding: metrics,
   agentMonitoringOnboarding: agentMonitoring,
   mcpOnboarding: mcp,
 };

static/app/gettingStartedDocs/node/node/metrics.tsx

@@ -0,0 +1,6 @@
+import {getNodeMetricsOnboarding} from './utils';
+
+export const metrics = getNodeMetricsOnboarding({
+  docsPlatform: 'node',
+  packageName: '@sentry/node',
+});

static/app/gettingStartedDocs/node/node/onboarding.spec.tsx

@@ -170,4 +170,44 @@ describe('node onboarding docs', () => {
       )
     ).not.toBeInTheDocument();
   });
+
+  it('displays metrics code in verify section when metrics are selected', () => {
+    renderWithOnboardingLayout(docs, {
+      selectedProducts: [ProductSolution.ERROR_MONITORING, ProductSolution.METRICS],
+    });
+
+    expect(
+      screen.getByText(
+        textWithMarkupMatcher(/Sentry\.metrics\.count\('test_counter', 1\)/)
+      )
+    ).toBeInTheDocument();
+  });
+
+  it('does not display metrics code in verify section when metrics are not selected', () => {
+    renderWithOnboardingLayout(docs, {
+      selectedProducts: [ProductSolution.ERROR_MONITORING],
+    });
+
+    expect(
+      screen.queryByText(
+        textWithMarkupMatcher(/Sentry\.metrics\.count\('test_counter', 1\)/)
+      )
+    ).not.toBeInTheDocument();
+  });
+
+  it('displays Metrics in next steps when metrics are selected', () => {
+    renderWithOnboardingLayout(docs, {
+      selectedProducts: [ProductSolution.ERROR_MONITORING, ProductSolution.METRICS],
+    });
+
+    expect(screen.getByText('Metrics')).toBeInTheDocument();
+  });
+
+  it('does not display Metrics in next steps when metrics are not selected', () => {
+    renderWithOnboardingLayout(docs, {
+      selectedProducts: [ProductSolution.ERROR_MONITORING],
+    });
+
+    expect(screen.queryByText('Metrics')).not.toBeInTheDocument();
+  });
 });

static/app/gettingStartedDocs/node/node/onboarding.tsx

@@ -260,6 +260,12 @@ Sentry.startSpan({
       action: 'test_error_span',
     });`
       : ''
+  }${
+    params.isMetricsSelected
+      ? `
+    // Send a test metric before throwing the error
+    Sentry.metrics.count('test_counter', 1);`
+      : ''
   }
     foo();
   } catch (e) {
@@ -276,7 +282,13 @@ Sentry.logger.info('User triggered test error', {
   action: 'test_error_basic',
 });`
     : ''
-}
+}${
+                params.isMetricsSelected
+                  ? `
+// Send a test metric before throwing the error
+Sentry.metrics.count('test_counter', 1);`
+                  : ''
+              }
 try {
   foo();
 } catch (e) {
@@ -300,6 +312,17 @@ try {
       });
     }
 
+    if (params.isMetricsSelected) {
+      steps.push({
+        id: 'metrics',
+        name: t('Metrics'),
+        description: t(
+          'Learn how to track custom metrics to monitor your application performance and business KPIs.'
+        ),
+        link: 'https://docs.sentry.io/platforms/javascript/guides/node/metrics/',
+      });
+    }
+
     return steps;
   },
 };

static/app/gettingStartedDocs/node/node/utils.tsx

@@ -852,6 +852,115 @@ Sentry.logger.info('User triggered test log', { action: 'test_log' })`,
   ],
 });
 
+export const getNodeMetricsOnboarding = <
+  PlatformOptions extends BasePlatformOptions = BasePlatformOptions,
+>({
+  docsPlatform,
+  packageName,
+}: {
+  docsPlatform: string;
+  packageName: `@sentry/${string}`;
+}): OnboardingConfig<PlatformOptions> => ({
+  install: (params: DocsParams) => [
+    {
+      type: StepType.INSTALL,
+      content: [
+        {
+          type: 'text',
+          text: tct(
+            'Add the Sentry SDK as a dependency. The minimum version of [packageName] that supports metrics is [code:10.24.0].',
+            {
+              code: <code />,
+              packageName: <code>{packageName}</code>,
+            }
+          ),
+        },
+        getInstallCodeBlock(params, {packageName}),
+        {
+          type: 'text',
+          text: tct(
+            'If you are on an older version of the SDK, follow our [link:migration guide] to upgrade.',
+            {
+              link: (
+                <ExternalLink
+                  href={`https://docs.sentry.io/platforms/javascript/guides/${docsPlatform}/migration/`}
+                />
+              ),
+            }
+          ),
+        },
+      ],
+    },
+  ],
+  configure: (params: DocsParams) => [
+    {
+      type: StepType.CONFIGURE,
+      content: [
+        {
+          type: 'text',
+          text: tct(
+            'Metrics are automatically enabled in your [code:Sentry.init()] configuration. You can emit metrics using the [code:Sentry.metrics] API.',
+            {code: <code />}
+          ),
+        },
+        {
+          type: 'code',
+          language: 'javascript',
+          code: `
+const Sentry = require("${packageName}");
+
+Sentry.init({
+  dsn: "${params.dsn.public}",
+});
+
+// Emit custom metrics
+Sentry.metrics.count('button_click', 1);
+Sentry.metrics.gauge('page_load_time', 150);
+Sentry.metrics.distribution('response_time', 200);
+`,
+        },
+        {
+          type: 'text',
+          text: tct(
+            'For more detailed information, see the [link:metrics documentation].',
+            {
+              link: (
+                <ExternalLink
+                  href={`https://docs.sentry.io/platforms/javascript/guides/${docsPlatform}/metrics/`}
+                />
+              ),
+            }
+          ),
+        },
+      ],
+    },
+  ],
+  verify: () => [
+    {
+      type: StepType.VERIFY,
+      content: [
+        {
+          type: 'text',
+          text: t(
+            'Send a test metric from your app to verify metrics are arriving in Sentry.'
+          ),
+        },
+        {
+          type: 'code',
+          language: 'javascript',
+          code: `const Sentry = require("${packageName}");
+
+// Emit a test metric
+Sentry.metrics.count('test_counter', 1);
+Sentry.metrics.gauge('test_gauge', 100);
+Sentry.metrics.distribution('test_distribution', 150);
+`,
+        },
+      ],
+    },
+  ],
+});
+
 /**
  *  Returns the init() with the necessary imports. It is possible to omit the imports.
  */