Skip to content

[timeseries] Introducing Apache ECharts timeseries results visualization in Controller UI#16390

Merged
ankitsultana merged 2 commits intoapache:masterfrom
shauryachats:echarts_timeseries
Jul 22, 2025
Merged

[timeseries] Introducing Apache ECharts timeseries results visualization in Controller UI#16390
ankitsultana merged 2 commits intoapache:masterfrom
shauryachats:echarts_timeseries

Conversation

@shauryachats
Copy link
Collaborator

@shauryachats shauryachats commented Jul 21, 2025

Summary

Integrates Apache ECharts for timeseries data visualization in Pinot Controller UI, providing interactive charts with performance-optimized truncation for large datasets.

The timeseries visualization in action:

timechart_overview.mov

Key Features

  • Timeseries Chart: Interactive ECharts visualization with mouse or drag-drop zoom capabilities, along with hover support.
  • Stats Table: Comprehensive metric statistics with ability to select single series and color coding.
  • Data Truncation: Automatic truncation to 20 series for performance optimization.
  • View Toggle: Switch between chart visualization and raw JSON output.
  • Warning System: Clear notifications when data is truncated.

Breaking Changes

None - all changes are additive and backward compatible.

Testing

Along with the aforementioned attached timeseries visualization video, testing has been done for other corner cases as well.

Large number of series:

Screenshot 2025-07-20 at 6 30 36 PM

Invalid query: (Clear surfacing of errors is a planned TODO and will be done in a subsequent PR).

Screenshot 2025-07-20 at 6 31 14 PM (2)

@codecov-commenter
Copy link

codecov-commenter commented Jul 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 63.32%. Comparing base (1a476de) to head (9c7a281).
Report is 489 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff              @@
##             master   #16390      +/-   ##
============================================
+ Coverage     62.90%   63.32%   +0.42%     
+ Complexity     1386     1363      -23     
============================================
  Files          2867     2976     +109     
  Lines        163354   172927    +9573     
  Branches      24952    26498    +1546     
============================================
+ Hits         102755   109509    +6754     
- Misses        52847    55051    +2204     
- Partials       7752     8367     +615     
Flag Coverage Δ
custom-integration1 100.00% <ø> (ø)
integration 100.00% <ø> (ø)
integration1 100.00% <ø> (ø)
integration2 0.00% <ø> (ø)
java-11 63.28% <ø> (+0.41%) ⬆️
java-21 63.30% <ø> (+0.48%) ⬆️
skip-bytebuffers-false ?
skip-bytebuffers-true ?
temurin 63.32% <ø> (+0.42%) ⬆️
unittests 63.32% <ø> (+0.42%) ⬆️
unittests1 56.46% <ø> (+0.64%) ⬆️
unittests2 33.29% <ø> (-0.29%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@jayeshchoudhary
Copy link
Contributor

jayeshchoudhary commented Jul 21, 2025

Screenshot 2025-07-21 at 12 08 58 PM

some portion of the popover gets hidden from the top
maybe we can change the popover behaviour to adapt and change its position on based on available space.

@jayeshchoudhary
Copy link
Contributor

Screenshot 2025-07-21 at 12 10 50 PM

how are we calculating bottom timeline?

it does not match with points we are rendering above, a bit off on the right side

Copy link
Contributor

@jayeshchoudhary jayeshchoudhary left a comment

Choose a reason for hiding this comment

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

did a first pass review, some minor comments

/**
* Maximum number of series that can be rendered in the chart
*/
export const MAX_SERIES_LIMIT = 20;
Copy link
Contributor

Choose a reason for hiding this comment

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

do we show warning at both places chart and table when the limit exceeds ?

Copy link
Contributor

Choose a reason for hiding this comment

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

also, what is the reason behind putting limit of these renderers?
is it because the chart will be too cluttered or react will face issues rending such large dataset.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We show a warning only at the chart because showing it at both places would be redundant - the stats table also acts as a legend.

The limit of these renders is both for clarity and to avoid any unexpected issues while rendering data over large datapoints. I am thinking of making this configurable in a subsequent PR.

@shauryachats
Copy link
Collaborator Author

@jayeshchoudhary good catch regarding the timeline not matching with the points! I added a 5% padding on either side of the timechart so that the points do not stick to either extremities, but did not accommodate that on the time axis. Will fix it.

@shauryachats
Copy link
Collaborator Author

Addressed the requested changes.

Screenshot 2025-07-21 at 3 26 04 PM (2)

Copy link
Contributor

@jayeshchoudhary jayeshchoudhary left a comment

Choose a reason for hiding this comment

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

🚢

@ankitsultana ankitsultana added timeseries-engine Tracking tag for generic time-series engine work timeseries-general-availability Work for making Timeseries Engine GA in Pinot (e.g. Controller UI support, debuggability, etc.) labels Jul 22, 2025
Copy link
Contributor

@ankitsultana ankitsultana left a comment

Choose a reason for hiding this comment

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

Lgtm. @shauryachats : let's make sure that:

  1. Errors are handled gracefully.
  2. If the response ends up being too big, it might crash the UI. In such cases maybe we should truncate the results somehow and return a warning? We can do this later, not required for v1

@ankitsultana ankitsultana merged commit ec97c6c into apache:master Jul 22, 2025
37 of 38 checks passed
@kishoreg
Copy link
Member

This looks great, and thank you for your contribution. Curious about the use case. There are many dashboarding tools like superset, redash, metabase, Grafana etc.

Who will be the main user of this?

@ankitsultana
Copy link
Contributor

ankitsultana commented Jul 23, 2025

@kishoreg : mainly for debugging from Quickstarts for development purposes, quick access for oncalls for debugging any customer reported issues, or just general adhoc exploration by end users if they have access to the controller UI.

Prior to this, one needed both a timeseries-plugin and a visualization tool to be able to test out Pinot's timeseries engine. With this only the timeseries-plugin is required for basic access.

(but a proper viz. tool like Grafana is still required for production use-cases)

@shauryachats shauryachats deleted the echarts_timeseries branch July 23, 2025 21:28
@kishoreg
Copy link
Member

ok. That makes sense. Let's ensure we include that in the documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

timeseries-engine Tracking tag for generic time-series engine work timeseries-general-availability Work for making Timeseries Engine GA in Pinot (e.g. Controller UI support, debuggability, etc.)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants