Browse Source

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 11 months ago
parent
commit
ebf71c5412

+ 0 - 39
docs/cloud/visualize/nodes.md

@@ -1,39 +0,0 @@
-# Nodes tab
-
-The Nodes tab lets you see and customize key metrics from any number of Agent-monitored nodes and seamlessly navigate
-to any node's dashboard for troubleshooting performance issues or anomalies using Netdata's highly-granular metrics.
-
-![The Nodes tab in Netdata
-Cloud](https://user-images.githubusercontent.com/1153921/119035218-2eebb700-b964-11eb-8b74-4ec2df0e457c.png)
-
-Each War Room's Nodes tab is populated based on the nodes you added to that specific War Room. Each node occupies a
-single row, first featuring that node's alert status (yellow for warnings, red for critical alerts) and operating
-system, some essential information about the node, followed by columns of user-defined key metrics represented in
-real-time charts.
-
-Use the [Overview](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md) for monitoring an infrastructure in real time using
-composite charts and Netdata's familiar dashboard UI.
-
-Check the [node
-filter](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/node-filter.md) and the [Visualization date time controls
-selector](https://github.com/netdata/netdata/blob/master/docs/dashboard/visualization-date-and-time-controls.md) for tools available on the utility bar.
-
-## Add and customize metrics columns
-
-Add more metrics columns by clicking the gear icon. Choose the context you'd like to add, give it a relevant name, and
-select whether you want to see all dimensions (the default), or only the specific dimensions your team is interested in.
-
-Click the gear icon and hover over any existing charts, then click the pencil icon. This opens a panel to
-edit that chart. Edit the context, its title, add or remove dimensions, or delete the chart altogether.
-
-These customizations appear for anyone else with access to that War Room.
-
-## See more metrics in Netdata Cloud
-
-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
-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) 
-to learn how to use dozens of pre-installed collectors that can instantly collect from your favorite services and applications.
-
-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
-[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)
-for finding the disk and RAM you need to store metrics for a certain period of time.

+ 57 - 0
docs/dashboard/nodes-tab.md

@@ -0,0 +1,57 @@
+# Nodes tab
+
+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.
+
+> **Tip**  
+>
+> Keep in mind that all configurations mentioned below are persistent and visible across all users.
+
+## Center information view
+
+The center information view consists of one row per node, and can be configured and filtered by the user.
+
+### Filtering and adjusting the view
+
+In the top right-hand corner, you can:
+
+- Order the nodes per status or per alert status
+- Select which charts you want to be displayed as quick reference points
+
+### Node row
+
+Each node row allows you to:
+
+- View the node's status
+- Go to a single node dashboard, by clicking the node name
+- View information about the node, along with a button to display more in the right-hand sidebar
+- View active alerts for the node
+- View Machine Learning status
+- View Functions capability status
+- Add configuration (beta)
+- [Add alert silencing rules](https://github.com/netdata/netdata/blob/master/docs/cloud/alerts-notifications/manage-alert-notification-silencing-rules.md)
+- View a set of key attributes collected on your node
+
+## Right bar
+
+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).
+
+### Node hierarchy
+
+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.
+
+### Filters sub-tab
+
+The second tab allows you to filter which nodes are displayed, you can filter by:
+
+- Host labels
+- Node status
+- Netdata version
+- Individual nodes
+
+### Alerts sub-tab
+
+The third tab displays room alerts and allows you to see additional information about each alert.
+
+### Info sub-tab
+
+The last tab presents information about a node, by clicking the `i` icon from a node's row, right next to its name.

+ 3 - 3
docs/quickstart/infrastructure.md

@@ -73,7 +73,7 @@ These tabs can be separated into "static", meaning they are by default presented
 
 - 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.
 
-- 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.
+- 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.
 
 - [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**.
 
@@ -172,7 +172,7 @@ collect from across your infrastructure with Netdata.
     title="Dashboards">
     <BoxList>
       <BoxListItemRegexLink to="[](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md)" title="Overview" />
-      <BoxListItemRegexLink to="[](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md)" title="Nodes tab" />
+      <BoxListItemRegexLink to="[](https://github.com/netdata/netdata/blob/master/docs/dashboard/nodes-tab.md)" title="Nodes tab" />
       <BoxListItemRegexLink to="[](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/kubernetes.md)" title="Kubernetes" />
       <BoxListItemRegexLink to="[](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/dashboards.md)" title="Create new dashboards" />
     </BoxList>
@@ -207,7 +207,7 @@ collect from across your infrastructure with Netdata.
   - [War Rooms](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/organize-your-infrastrucutre-invite-your-team.md#netdata-cloud-war-rooms)
 - Dashboards
   - [Overview](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md)
-  - [Nodes tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md)
+  - [Nodes tab](https://github.com/netdata/netdata/blob/master/docs/dashboard/nodes-tab.md)
   - [Kubernetes](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/kubernetes.md)
   - [Create new dashboards](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/dashboards.md)
 - Alerts and notifications

+ 2 - 2
src/claim/README.md

@@ -36,7 +36,7 @@ There will be three main flows from where you might want to connect a node to Ne
 
 - when you are on a [War Room](#empty-war-room) and you want to connect your first node
 - 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
-- 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
+- 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
 
 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.
 
@@ -62,7 +62,7 @@ finished onboarding.
 To connect a node, select which War Rooms you want to add this node to with the dropdown, then copy and paste the script
 given by Netdata Cloud into your node's terminal.
 
-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.
+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.
 
 ### Connect an agent running in Linux