revised node-tab document (#17348)
Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud> Co-authored-by: Hugo Valente <82235632+hugovalente-pm@users.noreply.github.com>
Fotis Voutsas committed
Apr 10, 2024 at 09:32 UTC
ebf71c541209f8af1c4a4fd5850fd359a730533c
4 files changed
+62
-44
docs/cloud/visualize/nodes.md
deleted
-39
@@ -1,39 +0,0 @@
1
-# Nodes tab
2
-
3
-The Nodes tab lets you see and customize key metrics from any number of Agent-monitored nodes and seamlessly navigate
4
-to any node's dashboard for troubleshooting performance issues or anomalies using Netdata's highly-granular metrics.
5
-
6
-
8
-
9
-Each War Room's Nodes tab is populated based on the nodes you added to that specific War Room. Each node occupies a
10
-single row, first featuring that node's alert status (yellow for warnings, red for critical alerts) and operating
11
-system, some essential information about the node, followed by columns of user-defined key metrics represented in
12
-real-time charts.
13
-
14
-Use the [Overview](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md) for monitoring an infrastructure in real time using
15
-composite charts and Netdata's familiar dashboard UI.
16
-
17
-Check the [node
18
-filter](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/node-filter.md) and the [Visualization date time controls
19
-selector](https://github.com/netdata/netdata/blob/master/docs/dashboard/visualization-date-and-time-controls.md) for tools available on the utility bar.
20
-
21
-## Add and customize metrics columns
22
-
23
-Add more metrics columns by clicking the gear icon. Choose the context you'd like to add, give it a relevant name, and
24
-select whether you want to see all dimensions (the default), or only the specific dimensions your team is interested in.
25
-
26
-Click the gear icon and hover over any existing charts, then click the pencil icon. This opens a panel to
27
-edit that chart. Edit the context, its title, add or remove dimensions, or delete the chart altogether.
28
-
29
-These customizations appear for anyone else with access to that War Room.
30
-
31
-## See more metrics in Netdata Cloud
32
-
33
-If you want to add more metrics to your War Rooms and they don't show up when you add new metrics to Nodes, you likely
34
-need to configure those nodes to collect from additional data sources. See our [collectors configuration reference](https://github.com/netdata/netdata/blob/master/src/collectors/REFERENCE.md)
35
-to learn how to use dozens of pre-installed collectors that can instantly collect from your favorite services and applications.
36
-
37
-If you want to see up to 30 days of historical metrics in Cloud (and more on individual node dashboards), read about [changing how long Netdata stores metrics](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md). Also, see our
38
-[calculator](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md#calculate-the-system-resources-ram-disk-space-needed-to-store-metrics)
39
-for finding the disk and RAM you need to store metrics for a certain period of time.
docs/dashboard/nodes-tab.md
new
+57
@@ -0,0 +1,57 @@
1
+# Nodes tab
2
+
3
+The nodes tab provides a summarized view of your [War Room](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/organize-your-infrastrucutre-invite-your-team.md#netdata-cloud-war-rooms), allowing you to view quick information per node.
4
+
5
+> **Tip**
6
+>
7
+> Keep in mind that all configurations mentioned below are persistent and visible across all users.
8
+
9
+## Center information view
10
+
11
+The center information view consists of one row per node, and can be configured and filtered by the user.
12
+
13
+### Filtering and adjusting the view
14
+
15
+In the top right-hand corner, you can:
16
+
17
+- Order the nodes per status or per alert status
18
+- Select which charts you want to be displayed as quick reference points
19
+
20
+### Node row
21
+
22
+Each node row allows you to:
23
+
24
+- View the node's status
25
+- Go to a single node dashboard, by clicking the node name
26
+- View information about the node, along with a button to display more in the right-hand sidebar
27
+- View active alerts for the node
28
+- View Machine Learning status
29
+- View Functions capability status
30
+- Add configuration (beta)
31
+- [Add alert silencing rules](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-alert-notification-silencing-rules.md)
32
+- View a set of key attributes collected on your node
33
+
34
+## Right bar
35
+
36
+The bar on the right-hand side provides additional information about the nodes in the War Room and allows you to filter what is displayed in the [center information view](#center-information-view).
37
+
38
+### Node hierarchy
39
+
40
+The first tab displays a hierarchy of the nodes displayed, making it easy to find a specific node by name. It follows the ordering that the user has selected.
41
+
42
+### Filters sub-tab
43
+
44
+The second tab allows you to filter which nodes are displayed, you can filter by:
45
+
46
+- Host labels
47
+- Node status
48
+- Netdata version
49
+- Individual nodes
50
+
51
+### Alerts sub-tab
52
+
53
+The third tab displays room alerts and allows you to see additional information about each alert.
54
+
55
+### Info sub-tab
56
+
57
+The last tab presents information about a node, by clicking the `i` icon from a node's row, right next to its name.
docs/quickstart/infrastructure.md
+3
-3
@@ -73,7 +73,7 @@ These tabs can be separated into "static", meaning they are by default presented
73
74
- The second and most important tab is the [Overview tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md#overview-and-single-node-view) which uses composite charts to display real-time metrics from every available node in a given War Room.
75
76
-- The [Nodes tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md) gives you the ability to see the status (offline or online), host details, alert status and also a short overview of some key metrics from all your nodes at a glance.
76
+- The [Nodes tab](https://github.com/netdata/netdata/blob/master/docs/dashboard/nodes-tab.md) gives you the ability to see the status (offline or online), host details, alert status and also a short overview of some key metrics from all your nodes at a glance.
77
78
- [Kubernetes tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/kubernetes.md) is a logical grouping of charts regarding your Kubernetes clusters. It contains a subset of the charts available in the **Overview tab**.
79
@@ -172,7 +172,7 @@ collect from across your infrastructure with Netdata.
172
title="Dashboards">
173
<BoxList>
174
<BoxListItemRegexLink to="[](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md)" title="Overview" />
175
- <BoxListItemRegexLink to="[](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md)" title="Nodes tab" />
175
+ <BoxListItemRegexLink to="[](https://github.com/netdata/netdata/blob/master/docs/dashboard/nodes-tab.md)" title="Nodes tab" />
176
<BoxListItemRegexLink to="[](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/kubernetes.md)" title="Kubernetes" />
177
<BoxListItemRegexLink to="[](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/dashboards.md)" title="Create new dashboards" />
178
</BoxList>
@@ -207,7 +207,7 @@ collect from across your infrastructure with Netdata.
207
- [War Rooms](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/organize-your-infrastrucutre-invite-your-team.md#netdata-cloud-war-rooms)
208
- Dashboards
209
- [Overview](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md)
210
- - [Nodes tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md)
210
+ - [Nodes tab](https://github.com/netdata/netdata/blob/master/docs/dashboard/nodes-tab.md)
211
- [Kubernetes](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/kubernetes.md)
212
- [Create new dashboards](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/dashboards.md)
213
- Alerts and notifications
src/claim/README.md
+2
-2
@@ -36,7 +36,7 @@ There will be three main flows from where you might want to connect a node to Ne
36
37
- when you are on a [War Room](#empty-war-room) and you want to connect your first node
38
- when you are at the [Manage Space](#manage-space-or-war-room) area and you select **Connect Nodes** to connect a node, coming from Manage Space or Manage War Room
39
-- when you are on the [Nodes tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md) and want to connect a node - this process falls into the [Manage Space](#manage-space-or-war-room) flow
39
+- when you are on the [Nodes tab](https://github.com/netdata/netdata/blob/master/docs/dashboard/nodes-tab.md) and want to connect a node - this process falls into the [Manage Space](#manage-space-or-war-room) flow
40
41
Please note that only the administrators of a Space in Netdata Cloud can view the claiming token and accompanying script, generated by Netdata Cloud, to trigger the connection process.
42
@@ -62,7 +62,7 @@ finished onboarding.
62
To connect a node, select which War Rooms you want to add this node to with the dropdown, then copy and paste the script
63
given by Netdata Cloud into your node's terminal.
64
65
-When coming from the [Nodes tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md) the room parameter is already defined to current War Room.
65
+When coming from the [Nodes tab](https://github.com/netdata/netdata/blob/master/docs/dashboard/nodes-tab.md) the room parameter is already defined to current War Room.
66
67
### Connect an agent running in Linux
68