You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@celeborn.apache.org by ni...@apache.org on 2024/03/08 02:02:56 UTC
(incubator-celeborn) branch main updated: [CELEBORN-1302] Introduce overview module for dashboard frontend
This is an automated email from the ASF dual-hosted git repository.
nicholasjiang pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-celeborn.git
The following commit(s) were added to refs/heads/main by this push:
new e78f63217 [CELEBORN-1302] Introduce overview module for dashboard frontend
e78f63217 is described below
commit e78f63217af1ce56aa7566c3128df03cdff41450
Author: tiny-dust <id...@foxmail.com>
AuthorDate: Fri Mar 8 10:02:47 2024 +0800
[CELEBORN-1302] Introduce overview module for dashboard frontend
### What changes were proposed in this pull request?
Introduce overview module for dashboard frontend:

### Why are the changes needed?
Dashboard frontend should support overview page to display the overview details of Celeborn.
### Does this PR introduce _any_ user-facing change?
no.
### How was this patch tested?
Local test.
Closes #2361 from tiny-dust/CELEBORN-1302.
Authored-by: tiny-dust <id...@foxmail.com>
Signed-off-by: SteNicholas <pr...@163.com>
---
web/src/api/index.ts | 6 ++-
.../api/models/{overview => application}/index.ts | 7 +++
.../application/types/application.ts} | 5 +-
.../{overview => application/types}/index.ts | 2 +-
web/src/api/models/{overview => cluster}/index.ts | 7 +++
.../{index.ts => models/cluster/types/cluster.ts} | 5 +-
web/src/api/{ => models/cluster/types}/index.ts | 2 +-
web/src/api/models/{overview => master}/index.ts | 7 +++
web/src/api/{ => models/master/types}/index.ts | 2 +-
.../{index.ts => models/master/types/master.ts} | 5 +-
web/src/api/models/{overview => storage}/index.ts | 7 +++
web/src/api/{ => models/storage/types}/index.ts | 2 +-
.../{index.ts => models/storage/types/storage.ts} | 6 ++-
web/src/api/models/{overview => worker}/index.ts | 7 +++
web/src/api/{ => models/worker/types}/index.ts | 2 +-
.../{index.ts => models/worker/types/worker.ts} | 7 ++-
web/src/api/request.ts | 13 ++++--
.../ApplicationOverview.vue} | 29 +++++++++---
.../{index.vue => components/ClusterOverview.vue} | 27 ++++++++---
.../{index.vue => components/MasterOverview.vue} | 28 ++++++++---
.../{index.vue => components/StorageOverview.vue} | 33 ++++++++++---
.../{index.vue => components/WorkerOverview.vue} | 31 ++++++++++---
.../{api => views/overview/components}/index.ts | 14 +++++-
web/src/views/overview/index.vue | 54 ++++++++++++++++++++--
web/vite.config.ts | 12 +++++
25 files changed, 266 insertions(+), 54 deletions(-)
diff --git a/web/src/api/index.ts b/web/src/api/index.ts
index ed31181ce..bba718779 100644
--- a/web/src/api/index.ts
+++ b/web/src/api/index.ts
@@ -15,4 +15,8 @@
* limitations under the License.
*/
-export * from './models/overview'
+export * from './models/application'
+export * from './models/cluster'
+export * from './models/master'
+export * from './models/storage'
+export * from './models/worker'
diff --git a/web/src/api/models/overview/index.ts b/web/src/api/models/application/index.ts
similarity index 81%
copy from web/src/api/models/overview/index.ts
copy to web/src/api/models/application/index.ts
index 68afce022..fd22f0df4 100644
--- a/web/src/api/models/overview/index.ts
+++ b/web/src/api/models/application/index.ts
@@ -16,3 +16,10 @@
*/
import { api } from '@/api/request'
+import type { ApplicationOverview } from './types'
+
+export * from './types'
+
+export const getApplicationOverview = () => {
+ return api<ApplicationOverview>('/application/overview', 'get')
+}
diff --git a/web/src/api/index.ts b/web/src/api/models/application/types/application.ts
similarity index 90%
copy from web/src/api/index.ts
copy to web/src/api/models/application/types/application.ts
index ed31181ce..8635c6ffb 100644
--- a/web/src/api/index.ts
+++ b/web/src/api/models/application/types/application.ts
@@ -15,4 +15,7 @@
* limitations under the License.
*/
-export * from './models/overview'
+export interface ApplicationOverview {
+ runningNum: number
+ totalShuffleSize: string
+}
diff --git a/web/src/api/models/overview/index.ts b/web/src/api/models/application/types/index.ts
similarity index 95%
copy from web/src/api/models/overview/index.ts
copy to web/src/api/models/application/types/index.ts
index 68afce022..9449baac4 100644
--- a/web/src/api/models/overview/index.ts
+++ b/web/src/api/models/application/types/index.ts
@@ -15,4 +15,4 @@
* limitations under the License.
*/
-import { api } from '@/api/request'
+export * from './application'
diff --git a/web/src/api/models/overview/index.ts b/web/src/api/models/cluster/index.ts
similarity index 82%
copy from web/src/api/models/overview/index.ts
copy to web/src/api/models/cluster/index.ts
index 68afce022..7f596e38c 100644
--- a/web/src/api/models/overview/index.ts
+++ b/web/src/api/models/cluster/index.ts
@@ -16,3 +16,10 @@
*/
import { api } from '@/api/request'
+import type { ClusterOverview } from './types'
+
+export * from './types'
+
+export const getClusterOverview = () => {
+ return api<ClusterOverview>('/cluster/overview', 'get')
+}
diff --git a/web/src/api/index.ts b/web/src/api/models/cluster/types/cluster.ts
similarity index 91%
copy from web/src/api/index.ts
copy to web/src/api/models/cluster/types/cluster.ts
index ed31181ce..1bddbea44 100644
--- a/web/src/api/index.ts
+++ b/web/src/api/models/cluster/types/cluster.ts
@@ -15,4 +15,7 @@
* limitations under the License.
*/
-export * from './models/overview'
+export interface ClusterOverview {
+ endpoint: string
+ leader: string
+}
diff --git a/web/src/api/index.ts b/web/src/api/models/cluster/types/index.ts
similarity index 95%
copy from web/src/api/index.ts
copy to web/src/api/models/cluster/types/index.ts
index ed31181ce..8d9eefe6d 100644
--- a/web/src/api/index.ts
+++ b/web/src/api/models/cluster/types/index.ts
@@ -15,4 +15,4 @@
* limitations under the License.
*/
-export * from './models/overview'
+export * from './cluster'
diff --git a/web/src/api/models/overview/index.ts b/web/src/api/models/master/index.ts
similarity index 83%
copy from web/src/api/models/overview/index.ts
copy to web/src/api/models/master/index.ts
index 68afce022..ca914e43a 100644
--- a/web/src/api/models/overview/index.ts
+++ b/web/src/api/models/master/index.ts
@@ -16,3 +16,10 @@
*/
import { api } from '@/api/request'
+import type { MasterOverview } from './types'
+
+export * from './types'
+
+export const getMasterOverview = () => {
+ return api<MasterOverview>('/master/overview', 'get')
+}
diff --git a/web/src/api/index.ts b/web/src/api/models/master/types/index.ts
similarity index 95%
copy from web/src/api/index.ts
copy to web/src/api/models/master/types/index.ts
index ed31181ce..569468179 100644
--- a/web/src/api/index.ts
+++ b/web/src/api/models/master/types/index.ts
@@ -15,4 +15,4 @@
* limitations under the License.
*/
-export * from './models/overview'
+export * from './master'
diff --git a/web/src/api/index.ts b/web/src/api/models/master/types/master.ts
similarity index 91%
copy from web/src/api/index.ts
copy to web/src/api/models/master/types/master.ts
index ed31181ce..04c112cde 100644
--- a/web/src/api/index.ts
+++ b/web/src/api/models/master/types/master.ts
@@ -15,4 +15,7 @@
* limitations under the License.
*/
-export * from './models/overview'
+export interface MasterOverview {
+ leaderNum: number
+ followerNum: number
+}
diff --git a/web/src/api/models/overview/index.ts b/web/src/api/models/storage/index.ts
similarity index 82%
copy from web/src/api/models/overview/index.ts
copy to web/src/api/models/storage/index.ts
index 68afce022..66be62ee8 100644
--- a/web/src/api/models/overview/index.ts
+++ b/web/src/api/models/storage/index.ts
@@ -16,3 +16,10 @@
*/
import { api } from '@/api/request'
+import type { StorageOverview } from './types'
+
+export * from './types'
+
+export const getStorageOverview = () => {
+ return api<StorageOverview>('/storage/overview', 'get')
+}
diff --git a/web/src/api/index.ts b/web/src/api/models/storage/types/index.ts
similarity index 95%
copy from web/src/api/index.ts
copy to web/src/api/models/storage/types/index.ts
index ed31181ce..a9c115df0 100644
--- a/web/src/api/index.ts
+++ b/web/src/api/models/storage/types/index.ts
@@ -15,4 +15,4 @@
* limitations under the License.
*/
-export * from './models/overview'
+export * from './storage'
diff --git a/web/src/api/index.ts b/web/src/api/models/storage/types/storage.ts
similarity index 89%
copy from web/src/api/index.ts
copy to web/src/api/models/storage/types/storage.ts
index ed31181ce..794ec1729 100644
--- a/web/src/api/index.ts
+++ b/web/src/api/models/storage/types/storage.ts
@@ -15,4 +15,8 @@
* limitations under the License.
*/
-export * from './models/overview'
+export interface StorageOverview {
+ diskUsage: string
+ memoryUsage: string
+ hdfsUsage: string
+}
diff --git a/web/src/api/models/overview/index.ts b/web/src/api/models/worker/index.ts
similarity index 83%
rename from web/src/api/models/overview/index.ts
rename to web/src/api/models/worker/index.ts
index 68afce022..a0d542707 100644
--- a/web/src/api/models/overview/index.ts
+++ b/web/src/api/models/worker/index.ts
@@ -16,3 +16,10 @@
*/
import { api } from '@/api/request'
+import type { WorkerOverview } from './types'
+
+export * from './types'
+
+export const getWorkerOverview = () => {
+ return api<WorkerOverview>('/worker/overview', 'get')
+}
diff --git a/web/src/api/index.ts b/web/src/api/models/worker/types/index.ts
similarity index 95%
copy from web/src/api/index.ts
copy to web/src/api/models/worker/types/index.ts
index ed31181ce..5677157cc 100644
--- a/web/src/api/index.ts
+++ b/web/src/api/models/worker/types/index.ts
@@ -15,4 +15,4 @@
* limitations under the License.
*/
-export * from './models/overview'
+export * from './worker'
diff --git a/web/src/api/index.ts b/web/src/api/models/worker/types/worker.ts
similarity index 86%
copy from web/src/api/index.ts
copy to web/src/api/models/worker/types/worker.ts
index ed31181ce..7e07c6319 100644
--- a/web/src/api/index.ts
+++ b/web/src/api/models/worker/types/worker.ts
@@ -15,4 +15,9 @@
* limitations under the License.
*/
-export * from './models/overview'
+export interface WorkerOverview {
+ normalNum: number
+ decommissionNum: number
+ lostNum: number
+ shutdownNum: number
+}
diff --git a/web/src/api/request.ts b/web/src/api/request.ts
index 434d88fbd..ae2611fca 100644
--- a/web/src/api/request.ts
+++ b/web/src/api/request.ts
@@ -56,13 +56,18 @@ export const useAxle = createUseAxle({
immediate: true
})
-export function api(url: string, method: RunnerMethod) {
- function load<V, P = Record<string, any>>(params?: P, config?: AxleRequestConfig): Promise<V> {
+export function api<V, P = Record<string, any>, R = V>(url: string, method: RunnerMethod) {
+ function load(params?: P, config?: AxleRequestConfig): Promise<V> {
return axle[method](url, params, config)
}
- function use<V, RV = V, P = Record<string, any>, R = RV>(options: Options<V, R, P> = {}) {
- return useAxle({ url, method, ...options })
+ function use(options: Options<V, R, P> = {}) {
+ const [data, getData, extra] = useAxle({ url, method, ...options })
+ return {
+ data,
+ getData,
+ ...extra
+ }
}
return {
diff --git a/web/src/views/overview/index.vue b/web/src/views/overview/components/ApplicationOverview.vue
similarity index 56%
copy from web/src/views/overview/index.vue
copy to web/src/views/overview/components/ApplicationOverview.vue
index c3da90346..1fc632a7c 100644
--- a/web/src/views/overview/index.vue
+++ b/web/src/views/overview/components/ApplicationOverview.vue
@@ -16,12 +16,27 @@
* limitations under the License.
-->
-<script setup lang="ts">
-defineOptions({
- name: 'OverView'
+<template>
+ <n-card hoverable>
+ <n-descriptions label-placement="left" title="Running Applications">
+ <n-descriptions-item label="Num"> {{ data.runningNum }} </n-descriptions-item>
+ <n-descriptions-item label="TotalShuffleSize">
+ {{ data.totalShuffleSize }}
+ </n-descriptions-item>
+ </n-descriptions>
+ </n-card>
+</template>
+<script lang="ts" setup>
+import type { ApplicationOverview } from '@/api'
+import type { PropType } from 'vue'
+
+defineProps({
+ data: {
+ type: Object as PropType<ApplicationOverview>,
+ default: () => ({
+ runningNum: 0,
+ totalShuffleSize: ''
+ })
+ }
})
</script>
-
-<template>Welcome to Apache Celeborn. There is OverView.</template>
-
-<style scoped lang="scss"></style>
diff --git a/web/src/views/overview/index.vue b/web/src/views/overview/components/ClusterOverview.vue
similarity index 59%
copy from web/src/views/overview/index.vue
copy to web/src/views/overview/components/ClusterOverview.vue
index c3da90346..8aed95062 100644
--- a/web/src/views/overview/index.vue
+++ b/web/src/views/overview/components/ClusterOverview.vue
@@ -16,12 +16,25 @@
* limitations under the License.
-->
-<script setup lang="ts">
-defineOptions({
- name: 'OverView'
+<template>
+ <n-card hoverable>
+ <n-descriptions label-placement="left" title="Cluster">
+ <n-descriptions-item label="Endpoint"> {{ data.endpoint }} </n-descriptions-item>
+ <n-descriptions-item label="Leader"> {{ data.leader }} </n-descriptions-item>
+ </n-descriptions>
+ </n-card>
+</template>
+<script lang="ts" setup>
+import type { ClusterOverview } from '@/api'
+import type { PropType } from 'vue'
+
+defineProps({
+ data: {
+ type: Object as PropType<ClusterOverview>,
+ default: () => ({
+ endpoint: '',
+ leader: ''
+ })
+ }
})
</script>
-
-<template>Welcome to Apache Celeborn. There is OverView.</template>
-
-<style scoped lang="scss"></style>
diff --git a/web/src/views/overview/index.vue b/web/src/views/overview/components/MasterOverview.vue
similarity index 58%
copy from web/src/views/overview/index.vue
copy to web/src/views/overview/components/MasterOverview.vue
index c3da90346..0eeb55439 100644
--- a/web/src/views/overview/index.vue
+++ b/web/src/views/overview/components/MasterOverview.vue
@@ -16,12 +16,26 @@
* limitations under the License.
-->
-<script setup lang="ts">
-defineOptions({
- name: 'OverView'
-})
-</script>
+<template>
+ <n-card hoverable>
+ <n-descriptions label-placement="left" title="Masters State Nums">
+ <n-descriptions-item label="Leader"> {{ data.leaderNum }} </n-descriptions-item>
+ <n-descriptions-item label="Follower"> {{ data.followerNum }} </n-descriptions-item>
+ </n-descriptions>
+ </n-card>
+</template>
-<template>Welcome to Apache Celeborn. There is OverView.</template>
+<script lang="ts" setup>
+import type { MasterOverview } from '@/api'
+import type { PropType } from 'vue'
-<style scoped lang="scss"></style>
+defineProps({
+ data: {
+ type: Object as PropType<MasterOverview>,
+ default: () => ({
+ leaderNum: 0,
+ followerNum: 0
+ })
+ }
+})
+</script>
diff --git a/web/src/views/overview/index.vue b/web/src/views/overview/components/StorageOverview.vue
similarity index 53%
copy from web/src/views/overview/index.vue
copy to web/src/views/overview/components/StorageOverview.vue
index c3da90346..96eb77cdc 100644
--- a/web/src/views/overview/index.vue
+++ b/web/src/views/overview/components/StorageOverview.vue
@@ -16,12 +16,31 @@
* limitations under the License.
-->
-<script setup lang="ts">
-defineOptions({
- name: 'OverView'
+<template>
+ <n-card hoverable>
+ <n-descriptions label-placement="left" title="Storage Usage Infos">
+ <n-descriptions-item label="Disk"> {{ data.diskUsage }} </n-descriptions-item>
+ <n-descriptions-item label="Memory">
+ {{ data.memoryUsage }}
+ </n-descriptions-item>
+ <n-descriptions-item label="HDFS">
+ {{ data.hdfsUsage }}
+ </n-descriptions-item>
+ </n-descriptions>
+ </n-card>
+</template>
+<script lang="ts" setup>
+import type { StorageOverview } from '@/api'
+import type { PropType } from 'vue'
+
+defineProps({
+ data: {
+ type: Object as PropType<StorageOverview>,
+ default: () => ({
+ diskUsage: '',
+ memoryUsage: '',
+ hdfsUsage: ''
+ })
+ }
})
</script>
-
-<template>Welcome to Apache Celeborn. There is OverView.</template>
-
-<style scoped lang="scss"></style>
diff --git a/web/src/views/overview/index.vue b/web/src/views/overview/components/WorkerOverview.vue
similarity index 50%
copy from web/src/views/overview/index.vue
copy to web/src/views/overview/components/WorkerOverview.vue
index c3da90346..2947720c8 100644
--- a/web/src/views/overview/index.vue
+++ b/web/src/views/overview/components/WorkerOverview.vue
@@ -16,12 +16,29 @@
* limitations under the License.
-->
-<script setup lang="ts">
-defineOptions({
- name: 'OverView'
-})
-</script>
+<template>
+ <n-card hoverable>
+ <n-descriptions label-placement="left" title="Worker State Nums" :column="4">
+ <n-descriptions-item label="Normal"> {{ data.normalNum }} </n-descriptions-item>
+ <n-descriptions-item label="Decommission"> {{ data.decommissionNum }} </n-descriptions-item>
+ <n-descriptions-item label="Lost"> {{ data.lostNum }} </n-descriptions-item>
+ <n-descriptions-item label="Shutdown"> {{ data.shutdownNum }} </n-descriptions-item>
+ </n-descriptions>
+ </n-card>
+</template>
-<template>Welcome to Apache Celeborn. There is OverView.</template>
+<script lang="ts" setup>
+import type { WorkerOverview } from '@/api'
+import type { PropType } from 'vue'
-<style scoped lang="scss"></style>
+defineProps({
+ data: {
+ type: Object as PropType<WorkerOverview>,
+ default: () => ({
+ decommissionNum: 0,
+ lostNum: 0,
+ shutdownNum: 0
+ })
+ }
+})
+</script>
diff --git a/web/src/api/index.ts b/web/src/views/overview/components/index.ts
similarity index 64%
copy from web/src/api/index.ts
copy to web/src/views/overview/components/index.ts
index ed31181ce..3a84ae008 100644
--- a/web/src/api/index.ts
+++ b/web/src/views/overview/components/index.ts
@@ -15,4 +15,16 @@
* limitations under the License.
*/
-export * from './models/overview'
+import ClusterOverviewService from './ClusterOverview.vue'
+import MasterOverviewService from './MasterOverview.vue'
+import WorkerOverviewService from './WorkerOverview.vue'
+import ApplicationOverviewService from './ApplicationOverview.vue'
+import StorageOverviewService from './StorageOverview.vue'
+
+export {
+ ClusterOverviewService,
+ MasterOverviewService,
+ WorkerOverviewService,
+ ApplicationOverviewService,
+ StorageOverviewService
+}
diff --git a/web/src/views/overview/index.vue b/web/src/views/overview/index.vue
index c3da90346..ea8498083 100644
--- a/web/src/views/overview/index.vue
+++ b/web/src/views/overview/index.vue
@@ -17,11 +17,59 @@
-->
<script setup lang="ts">
+import {
+ getApplicationOverview,
+ getClusterOverview,
+ getMasterOverview,
+ getStorageOverview,
+ getWorkerOverview
+} from '@/api'
+import {
+ ApplicationOverviewService,
+ ClusterOverviewService,
+ MasterOverviewService,
+ StorageOverviewService,
+ WorkerOverviewService
+} from './components'
+import { useHasLoading } from '@varlet/axle/use'
+
defineOptions({
name: 'OverView'
})
-</script>
-<template>Welcome to Apache Celeborn. There is OverView.</template>
+const { data: cluster, loading: isClusterLoading } = getClusterOverview().use()
+const { data: master, loading: isMasterLoading } = getMasterOverview().use()
+const { data: application, loading: isApplicationLoading } = getApplicationOverview().use()
+const { data: storage, loading: isStorageLoading } = getStorageOverview().use()
+const { data: worker, loading: isWorkerLoading } = getWorkerOverview().use()
+
+const loading = useHasLoading(
+ isClusterLoading,
+ isMasterLoading,
+ isApplicationLoading,
+ isStorageLoading,
+ isWorkerLoading
+)
+</script>
-<style scoped lang="scss"></style>
+<template>
+ <n-spin :show="loading">
+ <n-grid :x-gap="24" :y-gap="24" :cols="2">
+ <n-grid-item :span="2">
+ <ClusterOverviewService :data="cluster" />
+ </n-grid-item>
+ <n-grid-item>
+ <MasterOverviewService :data="master" />
+ </n-grid-item>
+ <n-grid-item>
+ <ApplicationOverviewService :data="application" />
+ </n-grid-item>
+ <n-grid-item>
+ <WorkerOverviewService :data="worker" />
+ </n-grid-item>
+ <n-grid-item>
+ <StorageOverviewService :data="storage" />
+ </n-grid-item>
+ </n-grid>
+ </n-spin>
+</template>
diff --git a/web/vite.config.ts b/web/vite.config.ts
index ed4dcf0a3..2f710c52c 100644
--- a/web/vite.config.ts
+++ b/web/vite.config.ts
@@ -25,6 +25,18 @@ import { NaiveUiResolver } from 'unplugin-vue-components/resolvers'
// https://vitejs.dev/config/
export default defineConfig({
+ // TODO: Get the backend service address and then change this uri.
+ server: {
+ proxy: {
+ '/api': {
+ target: '',
+ changeOrigin: true,
+ rewrite(path) {
+ return path.replace(/^\/api/, '')
+ }
+ }
+ }
+ },
plugins: [
vue(),
vueJsx(),