Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[GSoC] [UI] Dashboard Page #496

Merged
merged 35 commits into from
Jul 26, 2024
Merged

Conversation

Sylvie-Wxr
Copy link
Contributor

@Sylvie-Wxr Sylvie-Wxr commented Jul 23, 2024

  • If this is non-trivial feature, paste the links/URLs to the design doc.
  • Update the documentation to include this new feature.
  • Tests(including UT, IT, E2E) are added to verify the new feature.
  • If it's UI related, attach the screenshots below.
  • If this pull request closes/resolves/fixes an existing issue, replace the issue number. Fixes [GsoC][BanyanDB] Add Overview page in UI skywalking#10634.
  • Update the CHANGES log.

Dashboard Page Preview:
Dashboard default page

Auto Refresh Seletion:
Auto Refresh
When the page opens, the default is off, if select any option for auto refresh, the end time of datepicker will change every selected time frame, as well as the page.

Date Picker:
Date Picker
User can choose from different period of time as start time to current time as end time.

Path display:
truncate path
if the path is too long (over than 35 characters, it will show the first 5 and last 30 characters with '..." in the middle.

Smaller window display:
Text not display for small screen
Time components seperate lines
When the window is sizing down, the table dynamically sizes down. When it reaches certain pixel, the text in Memory and Disk Details will not be displayed, and at a more smaller pixel, the time componenents will be in shown in seperate lines to avoid messiness.

Table scroll with fixed time components:
Table scroll
Make the table scroll and time components fixed so that users can still monitor or choose different time if there are more lines of nodes.

Color display of the bar in CPU, Memory and Disk:
Bar color
(The picture is only for display only here). In actual code, the bar will be green when CPU/Memory/Disk is less tan 50%, will be Yellow from 50%-80%, red over 80%

No data display:
No data page
If there is no data written in the backend, there will be no data displayed like this.

@wu-sheng wu-sheng added this to the 0.7.0 milestone Jul 24, 2024
@wu-sheng wu-sheng added the ui Webapp related label Jul 24, 2024
@wu-sheng wu-sheng requested a review from hanahmily July 24, 2024 00:02
@hanahmily
Copy link
Contributor

@Sylvie-Wxr Would you introduce the Dashboard in observablity.md#metrics and add brief introduction and screenshot in cluster.md

First, explain how to enable the collection of self-observability metrics. To illustrate the flow of metrics data, insert the diagram from your design into the observability. Md file.

Next, it's important to specify the location where the metrics are stored. Lastly, ensure that the screenshot is included on the page.

@wu-sheng
Copy link
Member

png file should be hosted in the website repo to keep codes repo volume controllable.

@wu-sheng
Copy link
Member

Consider adding here, https://github.com/apache/skywalking-website/tree/master/static/doc-graph/banyandb/v0.7.0

Note, this is for 0.7 BanyanDB doc only.

@Sylvie-Wxr
Copy link
Contributor Author

Consider adding here, https://github.com/apache/skywalking-website/tree/master/static/doc-graph/banyandb/v0.7.0

Note, this is for 0.7 BanyanDB doc only.

Understood. Removed PNG from this repo.

@wu-sheng wu-sheng added the enhancement New feature or request label Jul 25, 2024
docs/observability.md Outdated Show resolved Hide resolved
docs/observability.md Outdated Show resolved Hide resolved
docs/observability.md Outdated Show resolved Hide resolved
docs/observability.md Show resolved Hide resolved
docs/observability.md Show resolved Hide resolved
Sylvie-Wxr and others added 5 commits July 24, 2024 21:18
Co-authored-by: Gao Hongtao <hanahmily@gmail.com>
Co-authored-by: Gao Hongtao <hanahmily@gmail.com>
Co-authored-by: Gao Hongtao <hanahmily@gmail.com>
Co-authored-by: Gao Hongtao <hanahmily@gmail.com>
@hanahmily
Copy link
Contributor

@Sylvie-Wxr Would you please attach the Dashboard screenshot at cluster installation

@Sylvie-Wxr
Copy link
Contributor Author

@Sylvie-Wxr Would you please attach the Dashboard screenshot at cluster installation

@hanahmily Updated.

@hanahmily hanahmily merged commit 3da0259 into apache:main Jul 26, 2024
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request ui Webapp related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[GsoC][BanyanDB] Add Overview page in UI
3 participants