Skip to content

feat: EXPKITS-1533 publish structured performance measurements - #247

Merged
zmolnar merged 1 commit into
feature/EXPKITS-1525-flowdata-upgradefrom
feature/EXPKITS-1533-structured-performance
Nov 16, 2026
Merged

zmolnar merged 1 commit into
feature/EXPKITS-1525-flowdata-upgradefrom
feature/EXPKITS-1533-structured-performance

Conversation

@zmolnar

@zmolnar zmolnar commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor

Goal

EXPKITS-1533: Publish performance measurements with explicit identity and availability.

Change

Before

Formatted text acted as the protocol. Display labels mixed unrelated histories; p95-only rows and unnamed scopes could disappear.

After

  • Publish optional numeric mean, p95 and FPS values; measured zero is distinct from unavailable.
  • Preserve the root producer in selectable overlay sources and saved selections. Replacing a publisher no longer matches its old selection.
  • Build detailed scope IDs from complete, length-prefixed parent hierarchies. Equal leaf names and delimiters cannot alias; incomplete names leave identity unavailable. Display labels stay separate.
  • Detect duplicate identities before filtering unavailable timings or FPS, so alternating availability cannot mix history.
  • Preserve established formatting, smoothing and cadence. Plumber continues to exclude performance diagnostics.
  • Update SDKs, producers, consumers and asynchronous publication fixtures together.

Testing

Coverage and historical validation

Native, wire and browser regressions cover hierarchy/reordering, truncated names, distinct publishers, saved selections and unavailable duplicates. The 10/100 ms reproduction now displays 100 ms rather than 55 ms. The execution-flow PlantUML source now names PerformanceMeasurementsT; PNGs are generated in documentation build output by ./scripts/gen-doc.sh, rather than committed source assets. Shared fixture work also addresses EXPKITS-1560.

Post-rebase evidence

The 2026-11-16 assembled-stack build, native/WebUI/Plumber tests, SDK/bundle checks
and documentation validation are recorded in the Testing section of #276
at aad8a7f218a2. These results supplement the earlier coverage above; they are not
standalone local reruns at every lower PR head.

Reproduction commands

From the repository root inside the supported OPK development container, with
the pinned submodules initialized and the normal model/media setup available:

NINJAFLAGS=-j2 ./scripts/build.sh debug true
meson test -C development/build-active --print-errorlogs --num-processes 2
./scripts/perception-sdk.sh check
./scripts/opksink-web.sh test
./scripts/opksink-web.sh check
PYTHONPATH=tools/plumber:generated/open_perception_kit/python/src python3 -m unittest discover -s tools/plumber/tests

From the host checkout, run ./scripts/gen-doc.sh to generate and validate the
documentation and diagrams in build output.

Links

Part of the breaking, unreleased SDK/product 1.0.0 refactor. Producers and consumers
must use compatible regenerated snapshots. Stable release packaging/publication is separate.

@zmolnar
zmolnar requested review from a team as code owners November 5, 2026 06:55
@zmolnar
zmolnar added this pull request to stack #248 November 5, 2026 06:56
@zmolnar

zmolnar commented Nov 5, 2026

Copy link
Copy Markdown
Contributor Author

All 18 checks now pass on d4c6cbf, including Clang-tidy, Valgrind, Meson, SDK tests, CodeQL and the x86_64/aarch64 quick-start browser smoke tests. The optional-access warnings were fixed without changing rendering behaviour; targeted local static analysis and pixel-equivalence tests also pass.

@zmolnar
zmolnar force-pushed the feature/EXPKITS-1533-structured-performance branch from d4c6cbf to 30c9172 Compare November 6, 2026 18:23
@zmolnar
zmolnar force-pushed the feature/EXPKITS-1533-structured-performance branch from 30c9172 to 655753b Compare November 6, 2026 18:57
@zmolnar
zmolnar force-pushed the feature/EXPKITS-1533-structured-performance branch 2 times, most recently from ea09046 to cf2f23a Compare November 11, 2026 10:31
@zmolnar
zmolnar force-pushed the feature/EXPKITS-1533-structured-performance branch from cf2f23a to e876229 Compare November 11, 2026 15:56

@Szendvics Szendvics left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nit: The execution-flow diagram source still says opkperformance appends PerformanceOverlayT. Please update it to PerformanceMeasurementsT and regenerate the diagram used by the architecture overview.

Comment thread development/web/src/frame-results.js Resolved
Comment thread development/web/src/performance-data.js Resolved
@zmolnar
zmolnar force-pushed the feature/EXPKITS-1533-structured-performance branch from e876229 to 4f0c70f Compare November 12, 2026 07:08
@zmolnar

zmolnar commented Nov 12, 2026

Copy link
Copy Markdown
Contributor Author

Addressed the diagram review note in 4f0c70f: execution-flow.puml now names PerformanceMeasurementsT, and docs/public/static/img/execution-flow.png was regenerated using the repository PlantUML 1.2026.2 toolchain. The generated PNG metadata confirms the updated source. All three inline performance findings also have fix/evidence replies.

Szendvics
Szendvics previously approved these changes Nov 12, 2026

@Szendvics Szendvics left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Rechecked the fixes at 4f0c70f3 and found no remaining blocking issues. The performance payload change is accepted as breaking, so migration of old saved performance preferences is not required.

Task: EXPKITS-1533

Replace text transport with typed numeric measurements, explicit producer and
scope identity, and independent mean/p95 availability. Preserve display labels
without using them as smoothing keys. Includes EXPKITS-1542 audit corrections.

Signed-off-by: Zoltan Molnar <zoltan.molnar@arm.com>
@zmolnar
zmolnar force-pushed the feature/EXPKITS-1533-structured-performance branch from 4f0c70f to ef6ce17 Compare November 16, 2026 12:50

@Szendvics Szendvics left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Approved as is.

@zmolnar
zmolnar enabled stacked auto-merge (squash) November 16, 2026 14:03
@zmolnar
zmolnar merged commit 80f7c4f into main Nov 16, 2026
31 of 36 checks passed
@zmolnar
zmolnar deleted the feature/EXPKITS-1533-structured-performance branch November 16, 2026 14:30
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