Skip to content

Commit 69e5281

Browse files
authored
Merge pull request #186 from aramd/add_overview_page_docs
docs: add Overview page documentation
2 parents a54dbd5 + fa5c059 commit 69e5281

File tree

5 files changed

+61
-0
lines changed

5 files changed

+61
-0
lines changed
186 KB
Loading
116 KB
Loading
158 KB
Loading
194 KB
Loading

docs/eportal/README.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1005,6 +1005,67 @@ The API key is personal, meaning it is tied to a specific user and inherits thei
10051005
A user with read-only permissions can only manage their own keys,
10061006
while an administrator has access to any user's API keys.
10071007

1008+
## Overview page
1009+
1010+
The Overview page provides a high-level summary of all selected servers.
1011+
It includes data on server uptime, CPU architecture, OS and kernel distribution,
1012+
and how many servers have KernelCare (KCare) or LibCare enabled.
1013+
1014+
### Uptime distribution
1015+
1016+
This section shows the uptime of servers where our agent is installed.
1017+
Uptime refers to how long the server has been running without a reboot.
1018+
1019+
The donut chart categorizes server uptime into:
1020+
1021+
- **under 6 months**
1022+
- **6 to 12 months**
1023+
- **12 to 18 months**
1024+
- **over 18 months**
1025+
1026+
Additional metrics:
1027+
1028+
- **Max uptime** — the longest uptime among servers with a reporting agent
1029+
- **Average uptime** — average uptime across these servers
1030+
- **Median uptime** — median uptime across these servers
1031+
1032+
![Uptime distribution](/images/overview_uptime_distribution.png)
1033+
1034+
### CPU arch distribution
1035+
1036+
Shows the breakdown of CPU architectures detected on servers.
1037+
If the architecture is not reported, it appears as `unknown`.
1038+
1039+
![Architecture distribution](/images/overview_arch_distribution.png)
1040+
1041+
### OS distribution
1042+
1043+
This table displays the top 10 most common operating system distributions among the selected servers,
1044+
along with how many of those servers have KernelCare (KCare) or LibCare enabled:
1045+
1046+
- **KCare active** — server has KCare enabled and is actively reporting
1047+
- **KCare silent** — server has KCare enabled, but is not currently reporting
1048+
- **LibCare active** — server has LibCare enabled and is actively reporting
1049+
- **LibCare silent** — server has LibCare enabled, but is not currently reporting
1050+
1051+
If more than 10 OS types are detected, the rest are grouped under an **"Other"** row.
1052+
A **Total** row summarizes all servers.
1053+
1054+
![OS distribution](/images/overview_os_distribution.png)
1055+
1056+
### Kernel distribution
1057+
1058+
This section lists the top 10 kernel versions detected across the selected servers,
1059+
along with how many servers are running each version with KCare enabled:
1060+
1061+
- **KCare active** — server has KCare enabled and is actively reporting
1062+
- **KCare silent** — server has KCare enabled, but is not currently reporting
1063+
1064+
If more than 10 kernel versions are detected, the rest are grouped under an "Other" row.
1065+
A **Total** row summarizes all servers.
1066+
1067+
![Kernel distribution](/images/overview_kernel_distribution.png)
1068+
10081069
## How to setup ePortal to use HTTPS
10091070

10101071
Some assumptions for a server where e-portal is deployed:

0 commit comments

Comments
 (0)