The Database Telemetry page was left out of the first release of the dashboard due to time, but it has always been a planned addition. This page will feature a Database Summary section that displays information about the orchestrators and allows a user to select and orchestrator to get shard information on. There will be Memory, Clients, and Keys sections where a user can select a shard within their chosen orchestrator to get information about its memory, clients, and keys.
Some older screenshots:
Justification
We expect that users will want details about their orchestrators and shards that is not currently captured in the Experiment Overview section.
Implementation Strategy
This page is mostly mocked up already, but it will need work to get it cooperating with the existing SmartDashboard codebase. I am very very hopeful that the schemas created for #7 will be able to be reused for this page, but they may need to be adjusted. There will need to be views additions for keys, clients, memory, and the database summary section because they all need to update similarly to the views in the Experiment Overview. Although the exact shape and content of the data is still being worked out, we know that we'll be gathering the shard data from the filesystem.
Acceptance Criteria
[x] Add Database Telemetry back into the dashboard using updated views for keys, clients, memory, and the database summary.
[x] Add a Database Telemetry section to the Help tab.
[x] Add a Database Telemetry section to the README and overview.rst doc file.
Description
The
Database Telemetrypage was left out of the first release of the dashboard due to time, but it has always been a planned addition. This page will feature aDatabase Summarysection that displays information about the orchestrators and allows a user to select and orchestrator to get shard information on. There will beMemory,Clients, andKeyssections where a user can select a shard within their chosen orchestrator to get information about its memory, clients, and keys.Some older screenshots:
Justification
We expect that users will want details about their orchestrators and shards that is not currently captured in the
Experiment Overviewsection.Implementation Strategy
This page is mostly mocked up already, but it will need work to get it cooperating with the existing SmartDashboard codebase. I am very very hopeful that the schemas created for #7 will be able to be reused for this page, but they may need to be adjusted. There will need to be views additions for keys, clients, memory, and the database summary section because they all need to update similarly to the views in the
Experiment Overview. Although the exact shape and content of the data is still being worked out, we know that we'll be gathering the shard data from the filesystem.Acceptance Criteria
viewsfor keys, clients, memory, and the database summary.