feat(onboarding): Add metrics onboarding for the Python SDK (#102641)

Empty state metrics onboarding for Python projects.

Closes LOGS-458

---------

Co-authored-by: Priscila Oliveira <[email protected]>

Author: alexander-alderman-webb

static/app/components/onboarding/productSelection.tsx

@@ -33,6 +33,7 @@ function getDisabledProducts(organization: Organization): DisabledProducts {
   const hasPerformance = organization.features.includes('performance-view');
   const hasProfiling = organization.features.includes('profiling-view');
   const hasLogs = organization.features.includes('ourlogs-enabled');
+  const hasMetrics = organization.features.includes('tracemetrics-enabled');
   const isSelfHostedErrorsOnly = ConfigStore.get('isSelfHostedErrorsOnly');
 
   let reason = t('This feature is not enabled on your Sentry installation.');
@@ -76,6 +77,12 @@ function getDisabledProducts(organization: Organization): DisabledProducts {
       onClick: createClickHandler('organizations:ourlogs-enabled', 'Logs'),
     };
   }
+  if (!hasMetrics) {
+    disabledProducts[ProductSolution.METRICS] = {
+      reason,
+      onClick: createClickHandler('organizations:tracemetrics-enabled', 'Metrics'),
+    };
+  }
   return disabledProducts;
 }
 
@@ -236,91 +243,109 @@ export const platformProductAvailability = {
     ProductSolution.PERFORMANCE_MONITORING,
     ProductSolution.PROFILING,
     ProductSolution.LOGS,
+    ProductSolution.METRICS,
   ],
   'python-aiohttp': [
     ProductSolution.PERFORMANCE_MONITORING,
     ProductSolution.PROFILING,
     ProductSolution.LOGS,
+    ProductSolution.METRICS,
   ],
   'python-asgi': [
     ProductSolution.PERFORMANCE_MONITORING,
     ProductSolution.PROFILING,
     ProductSolution.LOGS,
+    ProductSolution.METRICS,
   ],
   'python-awslambda': [
     ProductSolution.PERFORMANCE_MONITORING,
     ProductSolution.PROFILING,
     ProductSolution.LOGS,
+    ProductSolution.METRICS,
   ],
   'python-bottle': [
     ProductSolution.PERFORMANCE_MONITORING,
     ProductSolution.PROFILING,
     ProductSolution.LOGS,
+    ProductSolution.METRICS,
   ],
   'python-celery': [
     ProductSolution.PERFORMANCE_MONITORING,
     ProductSolution.PROFILING,
     ProductSolution.LOGS,
+    ProductSolution.METRICS,
   ],
   'python-chalice': [
     ProductSolution.PERFORMANCE_MONITORING,
     ProductSolution.PROFILING,
     ProductSolution.LOGS,
+    ProductSolution.METRICS,
   ],
   'python-django': [
     ProductSolution.PERFORMANCE_MONITORING,
     ProductSolution.PROFILING,
     ProductSolution.LOGS,
+    ProductSolution.METRICS,
   ],
   'python-falcon': [
     ProductSolution.PERFORMANCE_MONITORING,
     ProductSolution.PROFILING,
     ProductSolution.LOGS,
+    ProductSolution.METRICS,
   ],
   'python-fastapi': [
     ProductSolution.PERFORMANCE_MONITORING,
     ProductSolution.PROFILING,
     ProductSolution.LOGS,
+    ProductSolution.METRICS,
   ],
   'python-flask': [
     ProductSolution.PERFORMANCE_MONITORING,
     ProductSolution.PROFILING,
     ProductSolution.LOGS,
+    ProductSolution.METRICS,
   ],
   'python-gcpfunctions': [
     ProductSolution.PERFORMANCE_MONITORING,
     ProductSolution.PROFILING,
     ProductSolution.LOGS,
+    ProductSolution.METRICS,
   ],
   'python-quart': [
     ProductSolution.PERFORMANCE_MONITORING,
     ProductSolution.PROFILING,
     ProductSolution.LOGS,
+    ProductSolution.METRICS,
   ],
   'python-rq': [
     ProductSolution.PERFORMANCE_MONITORING,
     ProductSolution.PROFILING,
     ProductSolution.LOGS,
+    ProductSolution.METRICS,
   ],
   'python-serverless': [
     ProductSolution.PERFORMANCE_MONITORING,
     ProductSolution.PROFILING,
     ProductSolution.LOGS,
+    ProductSolution.METRICS,
   ],
   'python-tornado': [
     ProductSolution.PERFORMANCE_MONITORING,
     ProductSolution.PROFILING,
     ProductSolution.LOGS,
+    ProductSolution.METRICS,
   ],
   'python-starlette': [
     ProductSolution.PERFORMANCE_MONITORING,
     ProductSolution.PROFILING,
     ProductSolution.LOGS,
+    ProductSolution.METRICS,
   ],
   'python-wsgi': [
     ProductSolution.PERFORMANCE_MONITORING,
     ProductSolution.PROFILING,
     ProductSolution.LOGS,
+    ProductSolution.METRICS,
   ],
   ruby: [
     ProductSolution.PERFORMANCE_MONITORING,
@@ -531,6 +556,18 @@ export function ProductSelection({
           checked={urlProducts.includes(ProductSolution.LOGS)}
         />
       )}
+      {products.includes(ProductSolution.METRICS) && (
+        <Product
+          label={t('Metrics')}
+          description={t(
+            'Custom metrics for tracking application performance and usage, automatically trace-connected.'
+          )}
+          docLink="https://docs.sentry.io/product/explore/metrics/"
+          onClick={() => handleClickProduct(ProductSolution.METRICS)}
+          disabled={disabledProducts[ProductSolution.METRICS]}
+          checked={urlProducts.includes(ProductSolution.METRICS)}
+        />
+      )}
       {products.includes(ProductSolution.SESSION_REPLAY) && (
         <Product
           label={t('Session Replay')}

static/app/data/platformCategories.tsx

@@ -391,7 +391,29 @@ export const withoutLoggingSupport: Set<PlatformKey> = new Set([
 ]);
 
 // List of platforms that have metrics onboarding checklist content
-export const withMetricsOnboarding: Set<PlatformKey> = new Set([]);
+export const withMetricsOnboarding: Set<PlatformKey> = new Set([
+  'python',
+  'python-aiohttp',
+  'python-asgi',
+  'python-awslambda',
+  'python-bottle',
+  'python-celery',
+  'python-chalice',
+  'python-django',
+  'python-falcon',
+  'python-fastapi',
+  'python-flask',
+  'python-gcpfunctions',
+  'python-pyramid',
+  'python-quart',
+  'python-rq',
+  'python-sanic',
+  'python-serverless',
+  'python-starlette',
+  'python-tornado',
+  'python-tryton',
+  'python-wsgi',
+]);
 
 // List of platforms that do not have metrics support. We make use of this list in the product to not provide any Metrics
 export const withoutMetricsSupport: Set<PlatformKey> = new Set([]);

static/app/gettingStartedDocs/python/aiohttp/index.tsx

@@ -8,6 +8,7 @@ import {crashReport} from 'sentry/gettingStartedDocs/python/python/crashReport';
 import {featureFlag} from 'sentry/gettingStartedDocs/python/python/featureFlag';
 import {logs} from 'sentry/gettingStartedDocs/python/python/logs';
 import {mcp} from 'sentry/gettingStartedDocs/python/python/mcp';
+import {metrics} from 'sentry/gettingStartedDocs/python/python/metrics';
 import {profiling} from 'sentry/gettingStartedDocs/python/python/profiling';
 
 import {onboarding} from './onboarding';
@@ -22,6 +23,7 @@ const docs: Docs = {
   agentMonitoringOnboarding: agentMonitoring,
   mcpOnboarding: mcp,
   logsOnboarding: logs(),
+  metricsOnboarding: metrics(),
 };
 
 export default docs;

static/app/gettingStartedDocs/python/aiohttp/onboarding.spec.tsx

@@ -119,4 +119,30 @@ describe('aiohttp onboarding docs', () => {
       )
     ).not.toBeInTheDocument();
   });
+
+  it('renders metrics configuration when metrics are selected', () => {
+    renderWithOnboardingLayout(docs, {
+      selectedProducts: [ProductSolution.METRICS],
+    });
+
+    // Renders metrics verification steps
+    expect(
+      screen.getByText(
+        'Send test metrics from your app to verify metrics are arriving in Sentry.'
+      )
+    ).toBeInTheDocument();
+  });
+
+  it('renders without metrics configuration when metrics are not selected', () => {
+    renderWithOnboardingLayout(docs, {
+      selectedProducts: [],
+    });
+
+    // Does not render metrics verification steps
+    expect(
+      screen.queryByText(
+        'Send test metrics from your app to verify metrics are arriving in Sentry.'
+      )
+    ).not.toBeInTheDocument();
+  });
 });

static/app/gettingStartedDocs/python/aiohttp/onboarding.tsx

@@ -4,7 +4,8 @@ import {
   type DocsParams,
   type OnboardingConfig,
 } from 'sentry/components/onboarding/gettingStartedDoc/types';
-import {verify} from 'sentry/gettingStartedDocs/python/python/logs';
+import {logsVerify} from 'sentry/gettingStartedDocs/python/python/logs';
+import {metricsVerify} from 'sentry/gettingStartedDocs/python/python/metrics';
 import {alternativeProfiling} from 'sentry/gettingStartedDocs/python/python/profiling';
 import {
   getPythonAiocontextvarsCodeBlocks,
@@ -125,7 +126,8 @@ app.add_routes([web.get('/', hello)])
 web.run_app(app)
 `,
         },
-        verify(params),
+        logsVerify(params),
+        metricsVerify(params),
         {
           type: 'text',
           text: [

static/app/gettingStartedDocs/python/asgi/index.tsx

@@ -3,6 +3,7 @@ import {agentMonitoring} from 'sentry/gettingStartedDocs/python/python/agentMoni
 import {crashReport} from 'sentry/gettingStartedDocs/python/python/crashReport';
 import {logs} from 'sentry/gettingStartedDocs/python/python/logs';
 import {mcp} from 'sentry/gettingStartedDocs/python/python/mcp';
+import {metrics} from 'sentry/gettingStartedDocs/python/python/metrics';
 import {profiling} from 'sentry/gettingStartedDocs/python/python/profiling';
 
 import {onboarding} from './onboarding';
@@ -14,6 +15,7 @@ const docs: Docs = {
   agentMonitoringOnboarding: agentMonitoring,
   mcpOnboarding: mcp,
   logsOnboarding: logs(),
+  metricsOnboarding: metrics(),
 };
 
 export default docs;

static/app/gettingStartedDocs/python/asgi/onboarding.spec.tsx

@@ -115,4 +115,30 @@ describe('asgi onboarding docs', () => {
       )
     ).not.toBeInTheDocument();
   });
+
+  it('renders metrics configuration when metrics are selected', () => {
+    renderWithOnboardingLayout(docs, {
+      selectedProducts: [ProductSolution.METRICS],
+    });
+
+    // Renders metrics verification steps
+    expect(
+      screen.getByText(
+        'Send test metrics from your app to verify metrics are arriving in Sentry.'
+      )
+    ).toBeInTheDocument();
+  });
+
+  it('renders without metrics configuration when metrics are not selected', () => {
+    renderWithOnboardingLayout(docs, {
+      selectedProducts: [],
+    });
+
+    // Does not render metrics verification steps
+    expect(
+      screen.queryByText(
+        'Send test metrics from your app to verify metrics are arriving in Sentry.'
+      )
+    ).not.toBeInTheDocument();
+  });
 });

static/app/gettingStartedDocs/python/asgi/onboarding.tsx

@@ -4,7 +4,8 @@ import {
   type DocsParams,
   type OnboardingConfig,
 } from 'sentry/components/onboarding/gettingStartedDoc/types';
-import {verify} from 'sentry/gettingStartedDocs/python/python/logs';
+import {logsVerify} from 'sentry/gettingStartedDocs/python/python/logs';
+import {metricsVerify} from 'sentry/gettingStartedDocs/python/python/metrics';
 import {alternativeProfiling} from 'sentry/gettingStartedDocs/python/python/profiling';
 import {getPythonInstallCodeBlock} from 'sentry/gettingStartedDocs/python/python/utils';
 import {t, tct} from 'sentry/locale';
@@ -139,7 +140,8 @@ export const onboarding: OnboardingConfig = {
           language: 'python',
           code: getVerifySnippet(),
         },
-        verify(params),
+        logsVerify(params),
+        metricsVerify(params),
         {
           type: 'text',
           text: tct(

static/app/gettingStartedDocs/python/awslambda/index.tsx

@@ -2,6 +2,7 @@ import type {Docs} from 'sentry/components/onboarding/gettingStartedDoc/types';
 import {agentMonitoring} from 'sentry/gettingStartedDocs/python/python/agentMonitoring';
 import {crashReport} from 'sentry/gettingStartedDocs/python/python/crashReport';
 import {logs} from 'sentry/gettingStartedDocs/python/python/logs';
+import {metrics} from 'sentry/gettingStartedDocs/python/python/metrics';
 
 import {onboarding} from './onboarding';
 import {profiling} from './profiling';
@@ -12,6 +13,7 @@ const docs: Docs = {
   profilingOnboarding: profiling,
   agentMonitoringOnboarding: agentMonitoring,
   logsOnboarding: logs(),
+  metricsOnboarding: metrics(),
 };
 
 export default docs;

static/app/gettingStartedDocs/python/awslambda/onboarding.spec.tsx

@@ -97,4 +97,30 @@ describe('awslambda onboarding docs', () => {
       screen.queryByText(textWithMarkupMatcher(/enable_logs=True,/))
     ).not.toBeInTheDocument();
   });
+
+  it('renders metrics configuration when metrics are selected', () => {
+    renderWithOnboardingLayout(docs, {
+      selectedProducts: [ProductSolution.METRICS],
+    });
+
+    // Renders metrics verification steps
+    expect(
+      screen.getByText(
+        'Send test metrics from your app to verify metrics are arriving in Sentry.'
+      )
+    ).toBeInTheDocument();
+  });
+
+  it('renders without metrics configuration when metrics are not selected', () => {
+    renderWithOnboardingLayout(docs, {
+      selectedProducts: [],
+    });
+
+    // Does not render metrics verification steps
+    expect(
+      screen.queryByText(
+        'Send test metrics from your app to verify metrics are arriving in Sentry.'
+      )
+    ).not.toBeInTheDocument();
+  });
 });