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

Update upgrade-guide.md #207

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update upgrade-guide.md #207

wants to merge 1 commit into from

Conversation

sergiothinks2
Copy link
Contributor

Updated documentation in Startup Moment to be clearer.

@sergiothinks2 sergiothinks2 requested a review from a team as a code owner February 13, 2025 18:35
@sergiothinks2 sergiothinks2 requested review from davidlawrencer, ArielDemarco and NachoEmbrace and removed request for a team February 13, 2025 18:35
Copy link

Summary

Status Count
🔍 Total 312
✅ Successful 266
⏳ Timeouts 0
🔀 Redirected 0
👻 Excluded 46
❓ Unknown 0
🚫 Errors 0
Full Github Actions output

Copy link
Collaborator

@davidlawrencer davidlawrencer left a comment

Choose a reason for hiding this comment

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

@sergiothinks2 awesome rewrite, and exciting capabilities. added a couple questions we might want to clarify.

Measuring startup can be infinitely customizable, as you can add spans encapsulating native lifecycle events, any 3rd-party framework starts, and other factors that affect time prior to a user's ability to interact with the app. Using timestamps and a [span record](/ios/open-source/features/traces/#recording-a-completed-span), you can even measure events that occurred before the Embrace SDK. Additionally, Embrace's SDK creates a span `emb-setup` that measures the time for Embrace itself to launch.
#### How to Measure App Startup in v6.x

To track app startup, create a **trace with child spans** that capture key moments in your app’s initialization, such as:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we add what version of 6x this is first-available on?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@davidlawrencer per the changelog this was available starting in 6.0.0. Should I change this to

"Starting with version 6.0.0, to track app startup,......."


You can even measure events that occurred **before** the Embrace SDK initialized by using timestamps and a [span record](/ios/open-source/features/traces/#recording-a-completed-span).

Additionally, Embrace automatically records a span called **`emb-setup`**, which measures the time it takes for the SDK itself to launch.
Copy link
Collaborator

Choose a reason for hiding this comment

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

can someone instrumenting startup get this emb-setup span and add custom child spans? or does it exist on its own?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@davidlawrencer The emb-setup span exists on its own and cannot have custom child spans added to it because:

  • It's marked as a private span (meant for internal SDK observability)

  • It's immediately ended after creation during SDK initialization

  • It's not exposed through any public API

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.

2 participants