Skip to content
This repository has been archived by the owner on Aug 14, 2024. It is now read-only.

Add ttid/ttfd contribution flags to span data convention #1250

Merged
merged 3 commits into from
May 3, 2024

Conversation

markushi
Copy link
Member

@markushi markushi commented Apr 25, 2024

Add ui.ui.contributes_to_ttid and ui.ui.contributes_to_ttfd to the span data bag. The SDKs should set those flags on all spans which contribute to ttid / ttfd.

I'm still not 100% happy with the naming, if you have something better in mind, feel free to suggest!

Based on previous discussions here: https://www.notion.so/sentry/span-contribution-9b5a0979a81645789db6877593729cf4

Java impl: getsentry/sentry-java#3386

Preview deeplink: https://develop-git-feat-ttidttfdcontributingflags.sentry.dev/sdk/performance/span-data-conventions/#ui

Copy link

vercel bot commented Apr 25, 2024

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

Name Status Preview Comments Updated (UTC)
develop ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 3, 2024 5:10am

@@ -43,6 +43,8 @@ Below describes the conventions for the Span interface for the `data` field on t
| `frames.slow` | int | The number of slow frames rendered during the lifetime of the span. | `2` |
| `frames.frozen` | int | The number of frozen frames rendered during the lifetime of the span. | `1` |
| `frames.delay` | number | The sum of all delayed frame durations in seconds during the lifetime of the span. For more information see <Link to="/sdk/performance/frames-delay/">frames delay</Link>. | `1.3246` |
| `contributes_ttid` | boolean | Whether the span execution contributed to the TTID (time to initial display) metric. | `true` |
Copy link
Member Author

Choose a reason for hiding this comment

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

to preserve data, SDKs should probably only set the flag if it's value is true.

Copy link
Member

Choose a reason for hiding this comment

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

could we add a namespace for this? like mobile.contributes_ttid?

Copy link
Member

Choose a reason for hiding this comment

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

Actually I guess ttid could apply for gaming/browser in the future, could we make it ui.contributes_ttid instead?

Copy link
Member

Choose a reason for hiding this comment

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

I agree with ui.contributes_ttid. I think we could start a new category as mobile for this.

Copy link
Member

@philipphofmann philipphofmann left a comment

Choose a reason for hiding this comment

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

LGTM, thanks.

src/docs/sdk/performance/span-data-conventions.mdx Outdated Show resolved Hide resolved
Co-authored-by: Philipp Hofmann <philipp.hofmann@sentry.io>
@markushi markushi merged commit 8c2f0b0 into master May 3, 2024
5 checks passed
@markushi markushi deleted the feat/ttid_ttfd_contributing_flags branch May 3, 2024 05:31
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants