Skip to content
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.

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

Replaced all uses of description with name for start_span #11332

Merged
merged 8 commits into from
Oct 2, 2024

Conversation

antonpirker
Copy link
Member

@antonpirker antonpirker commented Sep 11, 2024

To align our API to OpenTelementry we deprecated the description parameter and added an alias name. (Because in OpenTelementry a span has no description but only a name)
When switching to OpenTelementry in the next major of the Python SDK description will be removed and only name can be uses. So we want to make sure users discovering Sentry now are already prepared for that.

(The ai_track is using internally the start_span and is giving its parameters to it. I removed the explixit parameter name, because it is not needed)

This should only be merged when the features has been released: getsentry/sentry-python#3524

Closes getsentry/sentry-python#3594

DESCRIBE YOUR PR

Tell us what you're changing and why. If your PR resolves an issue, please link it so it closes automatically.

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

Copy link

vercel bot commented Sep 11, 2024

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

3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
develop-docs ⬜️ Ignored (Inspect) Visit Preview Oct 2, 2024 9:14am
sentry-docs ⬜️ Ignored (Inspect) Visit Preview Oct 2, 2024 9:14am
changelog ⬜️ Skipped (Inspect) Oct 2, 2024 9:14am

Copy link

codecov bot commented Sep 11, 2024

Bundle Report

Changes will increase total bundle size by 14.09MB (99.77%) ⬆️⚠️, exceeding the configured threshold of 5%.

Bundle name Size Change
sentry-docs-server* 7.46MB 7.46MB (100%) ⬆️⚠️
sentry-docs-edge-server* 254.44kB 254.44kB (100%) ⬆️⚠️
sentry-docs-client* 6.38MB 6.38MB (100%) ⬆️⚠️
sentry-docs-server-cjs 7.45MB 6 bytes (-0.0%) ⬇️
sentry-docs-edge-server-array-push 257.07kB 3 bytes (-0.0%) ⬇️
sentry-docs-client-array-push 6.42MB 6 bytes (-0.0%) ⬇️

ℹ️ *Bundle size includes cached data from a previous commit

@antonpirker antonpirker self-assigned this Sep 13, 2024
Base automatically changed from antonpirker/python/custom-tracing-information to master October 2, 2024 08:53
@vercel vercel bot temporarily deployed to Preview – changelog October 2, 2024 09:11 Inactive
@antonpirker antonpirker merged commit c850177 into master Oct 2, 2024
9 checks passed
@antonpirker antonpirker deleted the antonpirker/python/span_description_is_now_name branch October 2, 2024 09:14
@github-actions github-actions bot locked and limited conversation to collaborators Oct 18, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Outdated documentation on start_span
3 participants