Skip to content

feat(onboarding): Simplify metrics onboarding for the Python SDK #103354

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Nov 17, 2025
Merged

feat(onboarding): Simplify metrics onboarding for the Python SDK #103354

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
dd80eed
feat(onboarding): Simplify metrics onboarding for the Python SDK
alexander-alderman-webb Nov 14, 2025
154180a
.
alexander-alderman-webb Nov 14, 2025
ac330e3
.
alexander-alderman-webb Nov 14, 2025
68b01e6
.
alexander-alderman-webb Nov 14, 2025
3700470
.
alexander-alderman-webb Nov 14, 2025
73849d9
.
alexander-alderman-webb Nov 14, 2025
a6fdc8f
.
alexander-alderman-webb Nov 14, 2025
c207cab
Merge branch 'master' into webb/python-simplify-metrics-onboarding
alexander-alderman-webb Nov 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 7 additions & 12 deletions static/app/gettingStartedDocs/python/metrics.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,16 @@ describe('metrics', () => {
expect(installSteps[0].type).toBe('install');
expect(installSteps[0].content).toHaveLength(2);

// Test configure step
const configureSteps = result.configure(mockParams);
expect(configureSteps).toHaveLength(1);
expect(configureSteps[0].type).toBe('configure');
expect(configureSteps[0].content[1].code).toContain('sentry_sdk.init');
expect(configureSteps[0].content[1].code).toContain(mockParams.dsn.public);

// Test verify step
const verifySteps = result.verify({isMetricsSelected: true});
const verifySteps = result.verify(mockParams);
expect(verifySteps).toHaveLength(1);
expect(verifySteps[0].type).toBe('verify');
expect(verifySteps[0].content).toHaveLength(1);
expect(verifySteps[0].content[0].type).toBe('conditional');
const conditionalContent = verifySteps[0].content[0].content;
expect(conditionalContent[1].code).toContain('metrics.count');
expect(verifySteps[0].content).toHaveLength(3);
const codeSnippet = verifySteps[0].content[1].code;

expect(codeSnippet).toContain('sentry_sdk.init');
expect(codeSnippet).toContain(mockParams.dsn.public);
expect(codeSnippet).toContain('metrics.count');
});

it('generates metrics onboarding config with custom parameters', () => {
Expand Down
12 changes: 3 additions & 9 deletions static/app/gettingStartedDocs/python/metrics.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,10 @@ export const metrics = ({
],
},
],
configure: (params: DocsParams) => [
configure: () => [],
verify: (params: DocsParams) => [
{
type: StepType.CONFIGURE,
type: StepType.VERIFY,
content: [
{
type: 'text',
Expand All @@ -80,7 +81,6 @@ sentry_sdk.init(
dsn="${params.dsn.public}",
)

# Emit custom metrics
metrics.count("checkout.failed", 1)
metrics.gauge("queue.depth", 42)
metrics.distribution("cart.amount_usd", 187.5)`,
Expand All @@ -99,10 +99,4 @@ metrics.distribution("cart.amount_usd", 187.5)`,
],
},
],
verify: (params: DocsParams) => [
{
type: StepType.VERIFY,
content: [metricsVerify(params)],
},
],
});
Loading