Document derived item ordering behavior in Telemetry Viewer#2695
Merged
Document derived item ordering behavior in Telemetry Viewer#2695
Conversation
Clarify that derived items are always returned last when telemetry packets are serialized for API responses. Add notes in Telemetry Viewer docs about derived item placement in auto-generated screens and include performance considerations for large screens. Fixes #2571 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2695 +/- ##
==========================================
- Coverage 79.31% 79.30% -0.01%
==========================================
Files 662 662
Lines 52588 52588
Branches 734 734
==========================================
- Hits 41708 41703 -5
- Misses 10800 10805 +5
Partials 80 80
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
EmilyRagan
requested changes
Dec 31, 2025
| - Avoid brackets in telemetry and item names | ||
|
|
||
| Array items use brackets to allow indexing into an individual item. Thus if you use brackets in item names it gets confusing as to whether this is a COSMOS [ARRAY_ITEM](telemetry#array_item) or simply a name with brackets. We support brackets for legacy reasons but avoid them when possible. Note that if you have existing telemetry names with brackets you must escape them in Telemetry Viewer screens by using double braces. For example from the Demo: `LABELVALUE INST HEALTH_STATUS BRACKET[[0]]` | ||
| Array items use brackets to allow indexing into an individual item. Thus if you use brackets in item names it gets confusing as to whether this is a COSMOS [ARRAY_ITEM](telemetry#array_item) or simply a name with brackets. We support brackets for legacy reasons but avoid them when possible. Note that if you have existing telemetry names with brackets you must escape them in Telemetry Viewer screens by using double braces. For example from the Demo: `LABELVALUE INST HEALTH_STATUS BRACKET[[0]]` |
Contributor
There was a problem hiding this comment.
The fact that we use the words "brackets" and "braces" in the same sentence to refer to the same character is a bit confusing. "Note that if you have existing telemetry names with brackets you must escape them in Telemetry Viewer screens by using double braces." Can we make this terminology consistent by using "brackets" in both places, since we are referring to the square characters and not the curly ones?
clayandgen
approved these changes
Jan 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
closes #2571