Skip to content

Conversation

@alexander-alderman-webb
Copy link
Contributor

@alexander-alderman-webb alexander-alderman-webb commented Nov 19, 2025

DESCRIBE YOUR PR

Improve metrics Python documentation by:

  • adding illustrative use cases to the introduction; and
  • explaining the before_send_metric() callback; and
  • adding individual examples for each metric type.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

@vercel
Copy link

vercel bot commented Nov 19, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
sentry-docs Ready Ready Preview Comment Nov 19, 2025 10:40am
1 Skipped Deployment
Project Deployment Preview Comments Updated (UTC)
develop-docs Ignored Ignored Preview Nov 19, 2025 10:40am

Copy link
Member

@chargome chargome left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

Copy link
Contributor

@sentrivana sentrivana left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, reads much nicer and clearer! Left a suggestion

Comment on lines 16 to 17
name="button_click",
value=5,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just passing name and value in as simple args makes this a bit more straightforward to read IMO, and it also communicates right away which args are required and which are optional:

Suggested change
name="button_click",
value=5,
"button_click",
5,

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed and changed, these were artifacts of the old metrics docs I copied the examples from.

Comment on lines 36 to 37
name="page_load",
value=15.0,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
name="page_load",
value=15.0,
"page_load",
15.0,

Comment on lines 56 to 57
name="page_load",
value=15.0,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
name="page_load",
value=15.0,
"page_load",
15.0,

@alexander-alderman-webb alexander-alderman-webb merged commit 8dbab0f into master Nov 19, 2025
13 checks passed
@alexander-alderman-webb alexander-alderman-webb deleted the webb/python-metrics-examples branch November 19, 2025 11:37
@codecov
Copy link

codecov bot commented Nov 19, 2025

Bundle Report

Changes will increase total bundle size by 1.84kB (0.01%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 12.76MB 1.85kB (0.01%) ⬆️
sentry-docs-client-array-push 10.17MB -6 bytes (-0.0%) ⬇️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.74MB -0.0%
../instrumentation.js -3 bytes 1.07MB -0.0%
9523.js -3 bytes 1.04MB -0.0%
../app/[[...path]]/page.js.nft.json 619 bytes 814.13kB 0.08%
../app/platform-redirect/page.js.nft.json 619 bytes 814.05kB 0.08%
../app/sitemap.xml/route.js.nft.json 619 bytes 811.28kB 0.08%
view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 882.71kB -0.0%
static/chunks/8321-*.js -3 bytes 425.87kB -0.0%
static/7FHIxqKAQW2_UJSLKMwL2/_buildManifest.js (New) 684 bytes 684 bytes 100.0% 🚀
static/7FHIxqKAQW2_UJSLKMwL2/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/ZmnXiJqGhkWPcGLatCBWU/_buildManifest.js (Deleted) -684 bytes 0 bytes -100.0% 🗑️
static/ZmnXiJqGhkWPcGLatCBWU/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️

codyde added a commit that referenced this pull request Nov 19, 2025
….com/getsentry/sentry-docs into feat/python-docs-nav-standardization

* 'feat/python-docs-nav-standardization' of https://github.com/getsentry/sentry-docs:
  ref: Allign badges with Sentry’s in-product ones (#15561)
  feat: Document exporting from OTLP from shopify hydrogen storefronts (#15534)
  docs(size-analysis): Update sentry-android-gradle-plugin to 6.0.0-beta.2 (#15560)
  fix(developer docs): Correcting width issues in developer docs for toc (#15559)
  docs(feature-flag): add documentation for php feature flags (#15443)
  feat(python): Illustrate types of metrics (#15556)
  fix(dev-docs): Buffer fixes for logs and metrics (#15513)
  docs(sourcemaps): Remove mentions of `sentry-cli sourcemaps explain` (#15481)
  ref(develop/scopes): Clarify unit type for attributes (#15546)
  ref(develop/spans): Clarify span attribute `unit` and `type` types (#15547)
  docs(metrics): add upcoming SDKs to Metrics getting started page (#15545)
  doc(proguard): No inbound filters (#15543)
  getsentry/relay@9b19609
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants