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

ref: Amend span creation names for RFC 101 #113

Merged
merged 1 commit into from
Sep 7, 2023

Conversation

AbhiPrasad
Copy link
Member

Discussed offline we decided to change the names of the span creator methods.

  • startActiveSpan -> startSpan
  • startSpan -> startInactiveSpan

lmk what you all think!

@AbhiPrasad AbhiPrasad requested review from a team, stephanie-anderson, lforst, HazAT, mydea and Lms24 and removed request for a team and lforst September 6, 2023 16:18
Copy link
Member

@mydea mydea left a comment

Choose a reason for hiding this comment

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

:shipit: sounds good to me!

@sentrivana
Copy link

I wasn't present during the discussion that led to this change so I don't want to approve on behalf of folks that were but wanted to say this change sounds great! Definitely makes the API more intuitive. :shipit:

Copy link
Member

@Lms24 Lms24 left a comment

Choose a reason for hiding this comment

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

Nice! I'm still not a fan of the "start" naming in the callback-based API (would have preferred something like trace) but this is just bike-shedding at this point and I also see the value in keeping this at least somewhat consistent across SDKs. Thanks for updating!

Copy link
Member

@sl0thentr0py sl0thentr0py left a comment

Choose a reason for hiding this comment

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

merci

@AbhiPrasad AbhiPrasad merged commit 4aa9a7e into main Sep 7, 2023
2 checks passed
@AbhiPrasad AbhiPrasad deleted the abhi-new-sdk-api-names branch September 7, 2023 11:48
AbhiPrasad added a commit to getsentry/sentry-javascript that referenced this pull request Sep 7, 2023
As per the new changes in RFC 101 in
getsentry/rfcs#113, update the span performance
API names.

- `startActiveSpan` -> `startSpan`
- `startSpan` -> `startInactiveSpan`

https://github.com/getsentry/rfcs/blob/main/text/0101-revamping-the-sdk-performance-api.md

`startActiveSpan` is deprecated, while `startInactiveSpan` is being
introduced. The breaking change is that `startSpan` is being changed,
but considering that basically no-one is using the `startSpan` API, we
should be fine to break here for correctness reasons. Better break now
than to have everyone refactor their code in v8.
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.

None yet

5 participants