skywalking icon indicating copy to clipboard operation
skywalking copied to clipboard

[GsoC][BanyanDB] Add Overview page in UI

Open hanahmily opened this issue 2 years ago • 3 comments

Search before asking

  • [X] I had searched in the issues and found no similar feature requirement.

Description

Background

SkyWalking BanyanDB is an observability database, aims to ingest, analyze and store Metrics, Tracing and Logging data.

The BanyanDB UI is a web interface provided BanyanDB server. It's developed with Vue3 and Vite3

Objectives

The UI should have a user-friendly Overview page. The Overview page must display a list of nodes running in a cluster. For each node in the list, the following information must be shown:

  • Node ID or name
  • Uptime
  • CPU usage (percentage)
  • Memory usage (percentage)
  • Disk usage (percentage)
  • Ports(gRPC and HTTP)

The web app must automatically refresh the node data at a configurable interval to show the most recent information.

Use case

No response

Related issues

No response

Are you willing to submit a PR?

  • [ ] Yes I am willing to submit a PR!

Code of Conduct

jira: https://issues.apache.org/jira/browse/GSOC-251

hanahmily avatar Apr 03 '23 04:04 hanahmily

Hello Hongtao, I am Rahul Raj, and I agree to participate in this project.

linktorahulraj avatar Apr 03 '23 07:04 linktorahulraj

Search before asking

  • [x] I had searched in the issues and found no similar feature requirement.

Description

Background

SkyWalking BanyanDB is an observability database, aims to ingest, analyze and store Metrics, Tracing and Logging data.

The BanyanDB UI is a web interface provided BanyanDB server. It's developed with Vue3 and Vite3

Objectives

The UI should have a user-friendly Overview page. The Overview page must display a list of nodes running in a cluster. For each node in the list, the following information must be shown:

  • Node ID or name
  • Uptime
  • CPU usage (percentage)
  • Memory usage (percentage)
  • Disk usage (percentage)
  • Ports(gRPC and HTTP)

The web app must automatically refresh the node data at a configurable interval to show the most recent information.

Use case

No response

Related issues

No response

Are you willing to submit a PR?

  • [ ] Yes I am willing to submit a PR!

Code of Conduct

jira: https://issues.apache.org/jira/browse/GSOC-251

To-Do List:

  1. Add a header section, add a navigation bar just below the header, & add a footer section.
  2. Design and implement the UI components to display the node data on the Overview page.
  3. Implement the functionality to automatically refresh the node data at a configurable interval.
  4. Implement the UI component to display the node ID or name.
  5. Implement the UI component to display the node uptime.
  6. Implement the UI component to display the node CPU usage.
  7. Implement the UI component to display the node memory usage.
  8. Implement the UI component to display the node disk usage.
  9. Implement the UI component to display the node ports (gRPC and HTTP)
  10. Fix any issues or bugs identified during the testing phase.
  11. Write documentation for the implemented features.

linktorahulraj avatar Apr 04 '23 15:04 linktorahulraj

@linktorahulraj, any updates?

hanahmily avatar Jun 07 '23 03:06 hanahmily