feat(observability-lib): add SortBy and SortDesc to LegendOptions#1799
Merged
feat(observability-lib): add SortBy and SortDesc to LegendOptions#1799
Conversation
Expose the underlying Grafana SDK's VizLegendOptions sorting fields to allow legend tables to be sorted by a specific calculation field (e.g., "Last *", "Max") in ascending or descending order. This enables dashboards to surface the most important series at the top of the legend table, improving readability for error rate panels.
leeyikjiun
temporarily deployed
to
integration
GitHub Actions
Inactive
leeyikjiun
temporarily deployed
to
integration
GitHub Actions
Inactive
leeyikjiun
temporarily deployed
to
integration
GitHub Actions
Inactive
✅ API Diff Results - No breaking changes |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds legend sorting capabilities to the observability-lib by exposing Grafana SDK's VizLegendOptions sorting fields. This enables dashboards to display the most important series (e.g., highest error rates) at the top of legend tables.
Changes:
- Added
SortByandSortDescfields toLegendOptionsstruct - Implemented conditional application of sorting options in
newLegendfunction
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
leeyikjiun
had a problem deploying
to
integration
GitHub Actions
Error
leeyikjiun
had a problem deploying
to
integration
GitHub Actions
Error
leeyikjiun
had a problem deploying
to
integration
GitHub Actions
Error
Only set SortDesc when SortBy is specified, and pass the value directly rather than hardcoding true.
leeyikjiun
force-pushed
the
feat/observability-lib-legend-sorting
branch
from
1342453 to
1ff9717
Compare
leeyikjiun
temporarily deployed
to
integration
GitHub Actions
Inactive
leeyikjiun
temporarily deployed
to
integration
GitHub Actions
Inactive
leeyikjiun
had a problem deploying
to
integration
GitHub Actions
Failure
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Fix comment examples to match actual Grafana format ("Last *", "Max")
- Only set SortDesc when true to avoid unnecessary explicit false values
leeyikjiun
had a problem deploying
to
integration
GitHub Actions
Error
leeyikjiun
had a problem deploying
to
integration
GitHub Actions
Error
leeyikjiun
had a problem deploying
to
integration
GitHub Actions
Error
leeyikjiun
force-pushed
the
feat/observability-lib-legend-sorting
branch
from
ad4f9a6 to
741332c
Compare
leeyikjiun
temporarily deployed
to
integration
GitHub Actions
Inactive
leeyikjiun
temporarily deployed
to
integration
GitHub Actions
Inactive
leeyikjiun
temporarily deployed
to
integration
GitHub Actions
Inactive
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Atrax1
approved these changes
Jan 27, 2026
pavel-raykov
approved these changes
Jan 27, 2026
jmank88
approved these changes
Jan 27, 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
4 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
Expose the underlying Grafana SDK's
VizLegendOptionssorting fields to allow legend tables to be sorted by a specific calculation field.SortByfield to specify which calculation to sort by (e.g., "Last *", "Max")SortDescfield to enable descending sort orderMotivation
This enables dashboards to surface the most important series at the top of the legend table, improving readability for error rate panels where you want to see the highest error rates first.
Test plan