Skip to content

[python] document new rust_tracing integration #11842

New issue

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

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

Already on GitHub? # to your account

Merged

Conversation

matt-codecov
Copy link
Contributor

DESCRIBE YOUR PR

A new Python SDK integration was created in getsentry/sentry-python#3717 + getsentry/sentry-python#3780 and this PR documents it.

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+

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

@matt-codecov matt-codecov requested review from antonpirker and a team November 15, 2024 23:42
Copy link

vercel bot commented Nov 15, 2024

@matt-codecov is attempting to deploy a commit to the Sentry Team on Vercel.

A member of the Team first needs to authorize it.

@matt-codecov matt-codecov changed the title Matt/python rust tracing integration [python] document new rust_tracing integration Nov 15, 2024
Copy link

vercel bot commented Nov 16, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 21, 2024 8:15am
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Nov 21, 2024 8:15am
develop-docs ⬜️ Ignored (Inspect) Visit Preview Nov 21, 2024 8:15am

Copy link
Member

@antonpirker antonpirker left a comment

Choose a reason for hiding this comment

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

From a technical perspective: very nice!

Docs team will also do a review to make sure the English and the voice is OK.

@antonpirker antonpirker requested a review from a team November 18, 2024 07:57
@lizokm lizokm requested a review from coolguyzone November 18, 2024 18:45

</Alert>

## Supported Versions
Copy link
Contributor

Choose a reason for hiding this comment

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

@matt-codecov Do you think it might be worth moving the 'supported versions' section to the top, right above the 'install' section? I feel like this info might be good to know right off the bat.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

i followed the structure of other integration pages and the ones i read all had this at the bottom

i am not even positive these are the correct minimum versions. i have not tested this with every rust/python version since the listed ones here, i just copied the minimum versions imposed by one of the dependencies (PyO3) since other integrations all had this section

Copy link
Contributor

@coolguyzone coolguyzone left a comment

Choose a reason for hiding this comment

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

Thanks for adding! Included a couple suggestions, but looks good to go 🫡

@matt-codecov
Copy link
Contributor Author

matt-codecov commented Nov 18, 2024

addressed the missing "configuring" and the broken link

aside from needing another vercel preview (which i'm not authorized to do @coolguyzone), the release of the Python SDK with this change in it has not actually gone out yet. i'll follow up here to merge after that happens

@antonpirker antonpirker merged commit 14b9138 into getsentry:master Nov 21, 2024
12 of 13 checks passed
@matt-codecov matt-codecov deleted the matt/python-rust-tracing-integration branch November 21, 2024 16:11
JoshuaMoelans pushed a commit that referenced this pull request Nov 22, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Dec 7, 2024
# for free to subscribe to this conversation on GitHub. Already have an account? #.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants