Skip to content

Commit f64aa1e

Browse files
committed
docs: fix admin dashboard panels and refresh intervals
1 parent 69d3f9a commit f64aa1e

4 files changed

Lines changed: 192 additions & 18 deletions

File tree

packages/backend.ai-webui-docs/src/en/dashboard/dashboard.md

Lines changed: 50 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,18 +28,32 @@ The page is composed of several main panels:
2828
Summarizes the overall used and free resources in the selected resource group.
2929
The data is aggregated from all agents that belong to the group.
3030

31+
:::note
32+
The **Total Resources in Resource Group** panel may not be visible depending on your
33+
system configuration.
34+
:::
35+
3136
- **Recently Created Sessions**:
3237
Lists the most recently created active sessions within the current project.
3338
Provides session details such as name, status, CPU/memory usage, environment, resource group,
3439
session type, and creation time.
3540
By default, the latest 5 active sessions are displayed.
3641

42+
When you are logged in as a superadmin, the Dashboard page also displays
43+
**Agent Statistics** and **Active Agents** panels alongside the standard user panels.
44+
See the [Superadmin Dashboard](#superadmin-dashboard) section for details on these panels.
45+
3746
## Auto-Refresh
3847

39-
The Dashboard automatically refreshes all panel data every 15 seconds. This
48+
The Dashboard automatically refreshes all panel data every **15 seconds**. This
4049
ensures that the displayed information stays up to date without requiring manual
4150
interaction.
4251

52+
:::note
53+
The superadmin dashboard uses a **30-second** refresh interval instead.
54+
See the [Superadmin Dashboard](#superadmin-dashboard) section for more information.
55+
:::
56+
4357
## Customizing the Dashboard Layout
4458

4559
You can customize the Dashboard layout by rearranging and resizing panels to
@@ -53,22 +67,54 @@ Your customized layout is automatically saved and persists across browser
5367
sessions. The layout is stored per user, so each user can have their own
5468
preferred arrangement.
5569

70+
:::tip
71+
When the WebUI is updated with new dashboard panels, those panels will
72+
automatically appear on your dashboard even if you have a saved custom layout.
73+
:::
74+
75+
:::note
76+
The user dashboard and the superadmin dashboard maintain separate saved layouts.
77+
Customizing the layout on one does not affect the other.
78+
:::
79+
5680
## Superadmin Dashboard
5781

58-
For superadmins, additional panels are available.
82+
The superadmin dashboard is a separate page available to superadmin users. It
83+
provides system-wide monitoring panels with a different set of panels from the
84+
user dashboard.
5985

6086
![](../images/admin_dashboard.png)
6187

62-
Except for **Active Sessions**, **Agent Statistics**, and **Active Agents**, the remaining panels
63-
display the same information as the user dashboard.
88+
The superadmin dashboard includes the following panels:
6489

6590
- **Active Sessions**:
6691
Shows the total number of active sessions across current projects,
6792
categorized by session type.
6893

94+
- **Total Resources in Resource Group**:
95+
Summarizes the overall used and free resources in the selected resource group,
96+
aggregated from all agents. This panel may not be visible depending on the
97+
system configuration.
98+
6999
- **Agent Statistics**:
70100
Provides all used resources across all agents in the system.
71101
The values represent the total used resources by all active sessions.
72102

103+
:::note
104+
The **Agent Statistics** panel requires backend support for the agent-stats
105+
feature and may not appear in all deployments.
106+
:::
107+
73108
- **Active Agents**:
74109
Lists all currently active agents in the system.
110+
111+
- **Recently Created Sessions**:
112+
Lists the most recently created active sessions within the current project.
113+
114+
:::note
115+
Unlike the user dashboard, the superadmin dashboard does **not** include the
116+
**My Total Resources Limit** or **My Resources in Resource Group** panels.
117+
:::
118+
119+
The superadmin dashboard refreshes all panel data every **30 seconds**, compared
120+
to the user dashboard's 15-second interval.

packages/backend.ai-webui-docs/src/ja/dashboard/dashboard.md

Lines changed: 45 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,23 @@
1818
- **リソースグループの総リソース:**
1919
選択されたリソースグループ全体の使用量と空き容量を要約表示します。グループに属するすべてのエージェントのデータを集計した値です。
2020

21+
:::note
22+
**リソースグループの総リソース**パネルは、システム構成によって表示されない場合があります。
23+
:::
24+
2125
- **最近作成されたセッション:**
2226
現在のプロジェクトで最近作成されたアクティブなセッション一覧を表示します。セッション名、ステータス、CPU/メモリ使用量、環境、リソースグループ、セッションタイプ、作成日時などの詳細を確認できます。デフォルトでは最新の5つのアクティブなセッションが表示されます。
2327

28+
スーパー管理者としてログインしている場合、ダッシュボードページには通常のユーザーパネルに加えて、**エージェントの統計**および**アクティブなエージェント**パネルも表示されます。これらのパネルの詳細については、[スーパー管理者ダッシュボード](#superadmin-dashboard)セクションを参照してください。
29+
2430
## 自動更新
2531

26-
ダッシュボードは15秒ごとにすべてのパネルデータを自動的に更新します。これにより、手動操作なしに常に最新の情報を確認できます。
32+
ダッシュボードは**15秒**ごとにすべてのパネルデータを自動的に更新します。これにより、手動操作なしに常に最新の情報を確認できます。
33+
34+
:::note
35+
スーパー管理者ダッシュボードでは、**30秒**間隔で更新されます。
36+
詳細については、[スーパー管理者ダッシュボード](#superadmin-dashboard)セクションを参照してください。
37+
:::
2738

2839
## ダッシュボードレイアウトのカスタマイズ
2940

@@ -34,19 +45,50 @@
3445

3546
カスタマイズされたレイアウトは自動的に保存され、ブラウザセッション間で保持されます。レイアウトはユーザーごとに保存されるため、各ユーザーが独自の配置を設定できます。
3647

48+
:::tip
49+
WebUIの更新で新しいダッシュボードパネルが追加された場合、保存済みのカスタムレイアウトが
50+
あっても、新しいパネルは自動的にダッシュボードに表示されます。
51+
:::
52+
53+
:::note
54+
ユーザーダッシュボードとスーパー管理者ダッシュボードのレイアウトは別々に保存されます。
55+
一方のレイアウトを変更しても、もう一方には影響しません。
56+
:::
57+
58+
<a id="superadmin-dashboard"></a>
59+
3760
## スーパー管理者ダッシュボード
3861

39-
スーパー管理者には追加のパネルが利用可能です
62+
スーパー管理者ダッシュボードは、スーパー管理者ユーザーが利用できる専用ページです。ユーザーダッシュボードとは異なるパネル構成で、システム全体をモニタリングするためのパネルを提供します
4063

4164
![](../images/admin_dashboard.png)
4265

43-
**アクティブセッション****エージェントの統計****アクティブなエージェント**を除く残りのパネルは、ユーザーダッシュボードと同じ情報を表示します。
66+
スーパー管理者ダッシュボードには以下のパネルが含まれます:
4467

4568
- **アクティブセッション:**
4669
現在のプロジェクトのアクティブなセッション総数をセッションタイプ別に分類して表示します。
4770

71+
- **リソースグループの総リソース:**
72+
選択されたリソースグループ全体の使用量と空き容量を、すべてのエージェントを集計して要約表示します。
73+
このパネルはシステム構成によって表示されない場合があります。
74+
4875
- **エージェントの統計:**
4976
システム内のすべてのエージェントで使用中のリソース状況を提供します。表示される値は、すべてのアクティブなセッションが使用しているリソースの総量です。
5077

78+
:::note
79+
**エージェントの統計**パネルはバックエンドのagent-stats機能のサポートが必要であり、
80+
デプロイメント環境によっては表示されない場合があります。
81+
:::
82+
5183
- **アクティブなエージェント:**
5284
システムで現在アクティブなすべてのエージェントの一覧を表示します。
85+
86+
- **最近作成されたセッション:**
87+
現在のプロジェクトで最近作成されたアクティブなセッション一覧を表示します。
88+
89+
:::note
90+
ユーザーダッシュボードとは異なり、スーパー管理者ダッシュボードには**私の総リソース制限**
91+
および**リソースグループの私のリソース**パネルは含まれません。
92+
:::
93+
94+
スーパー管理者ダッシュボードは、ユーザーダッシュボードの15秒間隔と比べて、**30秒**ごとにすべてのパネルデータを更新します。

packages/backend.ai-webui-docs/src/ko/dashboard/dashboard.md

Lines changed: 47 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,25 @@
2020
- **자원 그룹 내 총자원:**
2121
선택된 자원 그룹 전체의 사용량과 가용량을 요약하여 표시합니다. 그룹 내 모든 에이전트의 데이터를 합산해 계산된 값입니다.
2222

23+
:::note
24+
**자원 그룹 내 총자원** 패널은 시스템 구성에 따라 표시되지 않을 수 있습니다.
25+
:::
26+
2327
- **최근 생성 세션:**
2428
현재 프로젝트에서 가장 최근에 생성된 실행 중인 세션 목록을 보여 줍니다. 세션 이름, 상태, CPU/메모리 사용량, 환경, 자원 그룹, 세션 유형, 생성 일시 등을 확인할 수 있습니다. 기본적으로 최근 5개의 실행 중인 세션이 표시됩니다.
2529

30+
슈퍼관리자로 로그인한 경우, 대시보드 페이지에 일반 사용자 패널과 함께
31+
**에이전트 통계****활성 에이전트** 패널이 추가로 표시됩니다.
32+
이 패널에 대한 자세한 내용은 [슈퍼관리자 대시보드](#superadmin-dashboard) 섹션을 참고하세요.
33+
2634
## 자동 새로고침
2735

28-
대시보드는 모든 패널 데이터를 15초마다 자동으로 새로고침합니다. 이를 통해 수동 조작 없이도 항상 최신 정보를 확인할 수 있습니다.
36+
대시보드는 모든 패널 데이터를 **15초**마다 자동으로 새로고침합니다. 이를 통해 수동 조작 없이도 항상 최신 정보를 확인할 수 있습니다.
37+
38+
:::note
39+
슈퍼관리자 대시보드는 **30초** 간격으로 새로고침됩니다.
40+
자세한 내용은 [슈퍼관리자 대시보드](#superadmin-dashboard) 섹션을 참고하세요.
41+
:::
2942

3043
## 대시보드 레이아웃 커스터마이즈
3144

@@ -36,19 +49,50 @@
3649

3750
커스터마이즈된 레이아웃은 자동으로 저장되어 브라우저 세션 간에 유지됩니다. 레이아웃은 사용자별로 저장되므로, 각 사용자가 자신만의 배치를 설정할 수 있습니다.
3851

52+
:::tip
53+
WebUI 업데이트로 새로운 대시보드 패널이 추가되면, 저장된 커스텀 레이아웃이 있더라도
54+
새 패널이 대시보드에 자동으로 표시됩니다.
55+
:::
56+
57+
:::note
58+
사용자 대시보드와 슈퍼관리자 대시보드의 레이아웃은 별도로 저장됩니다.
59+
한쪽의 레이아웃을 변경해도 다른 쪽에는 영향을 주지 않습니다.
60+
:::
61+
62+
<a id="superadmin-dashboard"></a>
63+
3964
## 슈퍼관리자 대시보드
4065

41-
슈퍼관리자에게는 추가 패널이 제공됩니다.
66+
슈퍼관리자 대시보드는 슈퍼관리자 사용자에게 제공되는 별도의 페이지입니다. 사용자 대시보드와 다른 패널 구성으로 시스템 전체를 모니터링할 수 있는 패널을 제공합니다.
4267

4368
![](../images/admin_dashboard.png)
4469

45-
**활성 세션**, **에이전트 통계**, **활성 에이전트** 패널을 제외한 나머지 패널은 사용자 대시보드와 동일한 정보를 표시합니다.
70+
슈퍼관리자 대시보드에는 다음 패널이 포함됩니다.
4671

4772
- **활성 세션:**
4873
현재 프로젝트에서 실행 중인 세션의 총 개수를 세션 유형별로 분류하여 표시합니다.
4974

75+
- **자원 그룹 내 총자원:**
76+
선택된 자원 그룹 전체의 사용량과 가용량을 모든 에이전트를 합산하여 요약 표시합니다.
77+
이 패널은 시스템 구성에 따라 표시되지 않을 수 있습니다.
78+
5079
- **에이전트 통계:**
5180
시스템 내 모든 에이전트의 사용 중인 자원 현황을 제공합니다. 표시된 값은 모든 활성 세션이 사용 중인 자원의 총합입니다.
5281

82+
:::note
83+
**에이전트 통계** 패널은 백엔드의 agent-stats 기능 지원이 필요하며,
84+
배포 환경에 따라 표시되지 않을 수 있습니다.
85+
:::
86+
5387
- **활성 에이전트:**
5488
시스템에서 현재 활성화된 모든 에이전트 목록을 표시합니다.
89+
90+
- **최근 생성 세션:**
91+
현재 프로젝트에서 가장 최근에 생성된 실행 중인 세션 목록을 보여 줍니다.
92+
93+
:::note
94+
사용자 대시보드와 달리, 슈퍼관리자 대시보드에는 **나의 총자원 제한**
95+
**자원 그룹 내 나의 자원** 패널이 포함되지 않습니다.
96+
:::
97+
98+
슈퍼관리자 대시보드는 사용자 대시보드의 15초 간격과 달리 **30초**마다 모든 패널 데이터를 새로고침합니다.

0 commit comments

Comments
 (0)