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

chore: updating release telemetry to conform to style guides #8135

Merged
merged 1 commit into from
Dec 23, 2024

Conversation

jordanl17
Copy link
Member

Description

Telemetry should be:

Should be in the form of , e.g. Document Published, Studio Entered, or Trial Started, and be capitalized.

What to review

Testing

Notes for release

Copy link

vercel bot commented Dec 23, 2024

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

Name Status Preview Comments Updated (UTC)
page-building-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 23, 2024 2:47pm
performance-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 23, 2024 2:47pm
test-next-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 23, 2024 2:47pm
test-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 23, 2024 2:47pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
studio-workshop ⬜️ Ignored (Inspect) Dec 23, 2024 2:47pm

@jordanl17 jordanl17 marked this pull request as ready for review December 23, 2024 14:31
@jordanl17 jordanl17 requested a review from a team as a code owner December 23, 2024 14:31
Copy link
Contributor

No changes to documentation

Copy link
Contributor

Component Testing Report Updated Dec 23, 2024 2:40 PM (UTC)

✅ All Tests Passed -- expand for details
File Status Duration Passed Skipped Failed
comments/CommentInput.spec.tsx ✅ Passed (Inspect) 1m 3s 15 0 0
formBuilder/ArrayInput.spec.tsx ✅ Passed (Inspect) 12s 3 0 0
formBuilder/inputs/PortableText/Annotations.spec.tsx ✅ Passed (Inspect) 39s 6 0 0
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx ✅ Passed (Inspect) 50s 11 7 0
formBuilder/inputs/PortableText/copyPaste/CopyPasteFields.spec.tsx ✅ Passed (Inspect) 0s 0 12 0
formBuilder/inputs/PortableText/Decorators.spec.tsx ✅ Passed (Inspect) 26s 6 0 0
formBuilder/inputs/PortableText/DisableFocusAndUnset.spec.tsx ✅ Passed (Inspect) 14s 3 0 0
formBuilder/inputs/PortableText/DragAndDrop.spec.tsx ✅ Passed (Inspect) 27s 6 0 0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx ✅ Passed (Inspect) 1m 7s 15 0 0
formBuilder/inputs/PortableText/Input.spec.tsx ✅ Passed (Inspect) 1m 27s 21 0 0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx ✅ Passed (Inspect) 1m 39s 18 0 0
formBuilder/inputs/PortableText/PresenceCursors.spec.tsx ✅ Passed (Inspect) 12s 3 9 0
formBuilder/inputs/PortableText/Styles.spec.tsx ✅ Passed (Inspect) 26s 6 0 0
formBuilder/inputs/PortableText/Toolbar.spec.tsx ✅ Passed (Inspect) 1m 42s 21 0 0
formBuilder/tree-editing/TreeEditing.spec.tsx ✅ Passed (Inspect) 0s 0 3 0
formBuilder/tree-editing/TreeEditingNestedObjects.spec.tsx ✅ Passed (Inspect) 0s 0 3 0

Copy link
Contributor

⚡️ Editor Performance Report

Updated Mon, 23 Dec 2024 14:43:38 GMT

Benchmark reference
latency of sanity@latest
experiment
latency of this branch
Δ (%)
latency difference
article (title) 25.6 efps (39ms) 19.4 efps (52ms) +13ms (+32.1%) 🔴
article (body) 71.9 efps (14ms) 69.9 efps (14ms) +0ms (-/-%)
article (string inside object) 27.8 efps (36ms) 20.0 efps (50ms) +14ms (+38.9%) 🔴
article (string inside array) 25.6 efps (39ms) 18.2 efps (55ms) +16ms (+41.0%) 🔴
recipe (name) 54.1 efps (19ms) 33.3 efps (30ms) +12ms (+62.2%) 🔴
recipe (description) 58.8 efps (17ms) 36.4 efps (28ms) +11ms (+61.8%) 🔴
recipe (instructions) 99.9+ efps (5ms) 99.9+ efps (5ms) +0ms (-/-%)
synthetic (title) 19.8 efps (51ms) 7.9 efps (127ms) +76ms (+150.5%) 🔴
synthetic (string inside object) 19.6 efps (51ms) 8.1 efps (123ms) +72ms (+141.2%) 🔴

efps — editor "frames per second". The number of updates assumed to be possible within a second.

Derived from input latency. efps = 1000 / input_latency

Detailed information

🏠 Reference result

The performance result of sanity@latest

Benchmark latency p75 p90 p99 blocking time test duration
article (title) 39ms 45ms 61ms 351ms 182ms 10.4s
article (body) 14ms 17ms 25ms 152ms 189ms 5.2s
article (string inside object) 36ms 39ms 49ms 240ms 247ms 6.9s
article (string inside array) 39ms 41ms 46ms 172ms 132ms 6.8s
recipe (name) 19ms 20ms 26ms 37ms 0ms 8.5s
recipe (description) 17ms 18ms 20ms 26ms 0ms 4.3s
recipe (instructions) 5ms 7ms 9ms 21ms 0ms 3.0s
synthetic (title) 51ms 53ms 58ms 262ms 602ms 13.3s
synthetic (string inside object) 51ms 58ms 68ms 395ms 722ms 8.1s

🧪 Experiment result

The performance result of this branch

Benchmark latency p75 p90 p99 blocking time test duration
article (title) 52ms 60ms 107ms 549ms 1401ms 12.6s
article (body) 14ms 17ms 27ms 129ms 322ms 5.3s
article (string inside object) 50ms 53ms 61ms 84ms 553ms 8.0s
article (string inside array) 55ms 60ms 67ms 233ms 820ms 8.4s
recipe (name) 30ms 32ms 37ms 57ms 0ms 9.0s
recipe (description) 28ms 29ms 32ms 78ms 0ms 5.5s
recipe (instructions) 5ms 6ms 7ms 31ms 0ms 3.0s
synthetic (title) 127ms 138ms 151ms 273ms 6130ms 19.8s
synthetic (string inside object) 123ms 131ms 141ms 757ms 5950ms 16.0s

📚 Glossary

column definitions

  • benchmark — the name of the test, e.g. "article", followed by the label of the field being measured, e.g. "(title)".
  • latency — the time between when a key was pressed and when it was rendered. derived from a set of samples. the median (p50) is shown to show the most common latency.
  • p75 — the 75th percentile of the input latency in the test run. 75% of the sampled inputs in this benchmark were processed faster than this value. this provides insight into the upper range of typical performance.
  • p90 — the 90th percentile of the input latency in the test run. 90% of the sampled inputs were faster than this. this metric helps identify slower interactions that occurred less frequently during the benchmark.
  • p99 — the 99th percentile of the input latency in the test run. only 1% of sampled inputs were slower than this. this represents the worst-case scenarios encountered during the benchmark, useful for identifying potential performance outliers.
  • blocking time — the total time during which the main thread was blocked, preventing user input and UI updates. this metric helps identify performance bottlenecks that may cause the interface to feel unresponsive.
  • test duration — how long the test run took to complete.

@jordanl17 jordanl17 merged commit be255dc into corel Dec 23, 2024
55 of 56 checks passed
@jordanl17 jordanl17 deleted the corel-296-telemetry-names branch December 23, 2024 14:51
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.

1 participant