remove old overview infrastructure and add home tab doc (#17323)
Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud> Co-authored-by: Hugo Valente <82235632+hugovalente-pm@users.noreply.github.com>
Fotis Voutsas committed
Apr 5, 2024 at 15:04 UTC
128f112c7313ce97d166213303f1bc47500369d3
8 files changed
+67
-106
docs/collect/application-metrics.md
+1
-1
@@ -78,6 +78,6 @@ collector](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d
78
79
Collecting all the available metrics on your nodes, and across your entire infrastructure, is just one piece of the
80
puzzle. Next, learn more about Netdata's famous real-time visualizations by [seeing an overview of your
81
-infrastructure](https://github.com/netdata/netdata/blob/master/docs/visualize/overview-infrastructure.md) using Netdata Cloud.
81
+infrastructure](https://github.com/netdata/netdata/blob/master/docs/dashboard/home-tab.md) using Netdata Cloud.
82
83
docs/collect/container-metrics.md
+1
-1
@@ -96,6 +96,6 @@ Netdata is capable of collecting metrics from hundreds of applications, such as
96
brokers, and more. See more in the [application metrics doc](https://github.com/netdata/netdata/blob/master/docs/collect/application-metrics.md).
97
98
If you already have all the information you need about collecting metrics, move into Netdata's meaningful visualizations
99
-with [seeing an overview of your infrastructure](https://github.com/netdata/netdata/blob/master/docs/visualize/overview-infrastructure.md) using Netdata Cloud.
99
+with [seeing an overview of your infrastructure](https://github.com/netdata/netdata/blob/master/docs/dashboard/home-tab.md) using Netdata Cloud.
100
101
docs/dashboard/home-tab.md
new
+60
@@ -0,0 +1,60 @@
1
+# Home Tab
2
+
3
+The Home tab allows users to see an overview of their Room.
4
+
5
+## Total nodes
6
+
7
+The total number of nodes is presented and dissected by their state, Live, Offline or Stale.
8
+
9
+## Active alerts
10
+
11
+The number of active alerts is presented in a donut chart, while also having counters for both Critical and Warning alerts.
12
+
13
+## Nodes map
14
+
15
+A map consisting of node entries allows for quick hoverable information about each node, while also presenting node status in a color-coded way.
16
+
17
+The map classification can be altered, allowing the categorization of nodes by:
18
+
19
+- Status (e.g. Live)
20
+- OS (e.g. Ubuntu)
21
+- Technology (e.g. Container)
22
+- Agent version (e.g. v1.45.2)
23
+- Replication factor (e.g. Single, Multi)
24
+- Cloud provider (e.g AWS)
25
+- Cloud region (e.g. us-east-1)
26
+- Instance type (e.g. c6a.xlarge)
27
+
28
+Color-coding can also be configured between:
29
+
30
+- Status (e.g. Live, Offline)
31
+- Connection stability (e.g. Stable, Unstable)
32
+- Replication factor (e.g. None, Single)
33
+
34
+## Data replication
35
+
36
+There are two views about data replication in the Home tab:
37
+
38
+The first bar chart presents the amount of **Parents**, **Children** and **Standalone** nodes.
39
+
40
+The second bar chart presents the number of nodes depending on their Replication factor, **None**, **Single** and **Multi**.
41
+
42
+## Alerts overview over the last 24h
43
+
44
+There are two views that display information about nodes that produced the most alerts and top alerts in the last 24 hours.
45
+
46
+The first bar chart presents the nodes that produced the most alerts in a time window of the last 24 hours.
47
+
48
+The second table contains the top alerts in the last 24 hours, along with their instance, the occurrences and their duration in seconds.
49
+
50
+## Netdata Assistant shortcut
51
+
52
+In the Home tab there is a shortcut button in order to start an instant conversation with the [Netdata Assistant](https://github.com/netdata/netdata/edit/master/docs/cloud/netdata-assistant.md).
53
+
54
+## Space metrics
55
+
56
+There are three key metrics that are displayed in the Home tab, **Metrics collected**, **Charts visualized** and **Alerts configured**.
57
+
58
+## Data retention per Nodes
59
+
60
+This bar chart shows the number of nodes based on their retention period.
docs/guides/monitor/kubernetes-k8s-netdata.md
-3
@@ -118,9 +118,6 @@ cluster](https://user-images.githubusercontent.com/1153921/109042169-19c8fa00-76
118
For example, the chart above shows a spike in the CPU utilization from `rabbitmq` every minute or so, along with a
119
baseline CPU utilization of 10-15% across the cluster.
120
121
-Read about the [Overview](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md) and some best practices on [viewing
122
-an overview of your infrastructure](https://github.com/netdata/netdata/blob/master/docs/visualize/overview-infrastructure.md) for details on using composite charts to
123
-drill down into per-node performance metrics.
121
122
## Pod and container metrics
123
docs/guides/troubleshoot/monitor-debug-applications-ebpf.md
+2
-2
@@ -241,8 +241,8 @@ findings with someone else on your team.
241
If you don't already have a Netdata Cloud account, go [sign in](https://app.netdata.cloud) and get started for free.
242
You can also read how to [monitor your infrastructure with Netdata Cloud](https://github.com/netdata/netdata/blob/master/docs/quickstart/infrastructure.md) to understand the key features that it has to offer.
243
244
-Once you've added one or more nodes to a Space in Netdata Cloud, you can see aggregated eBPF metrics in the [Overview
245
-dashboard](https://github.com/netdata/netdata/blob/master/docs/visualize/overview-infrastructure.md) under the same **Applications** or **eBPF** sections that you
244
+Once you've added one or more nodes to a Space in Netdata Cloud, you can see aggregated eBPF metrics in the Overview
245
+dashboard under the same **Applications** or **eBPF** sections that you
246
find on the local Agent dashboard. Or, [create new dashboards](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/dashboards.md) using eBPF metrics
247
from any number of distributed nodes to see how your application interacts with multiple Linux kernels on multiple Linux
248
systems.
docs/quickstart/infrastructure.md
+1
-2
@@ -99,8 +99,7 @@ Both the Overview and the Nodes tab offer easy access to **single-node dashboard
99
single-node dashboards in Netdata Cloud to drill down on specific issues, scrub backward in time to investigate
100
historical data, and see like metrics presented meaningfully to help you troubleshoot performance problems.
101
102
-Read about the process in the [infrastructure
103
-overview](https://github.com/netdata/netdata/blob/master/docs/visualize/overview-infrastructure.md#drill-down-with-single-node-dashboards) doc, then learn about [interacting with
102
+Learn more about [interacting with
103
dashboards and charts](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md) to get the most from all of Netdata's real-time
104
metrics.
105
docs/visualize/overview-infrastructure.md
deleted
-95
@@ -1,95 +0,0 @@
1
-<!--
2
-title: "See an overview of your infrastructure"
3
-description: "With Netdata Cloud's War Rooms, you can see real-time metrics, from any number of nodes in your infrastructure, in composite charts."
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/visualize/overview-infrastructure.md
5
-sidebar_label: "See an overview of your infrastructure"
6
-learn_status: "Published"
7
-learn_topic_type: "Tasks"
8
-learn_rel_path: "Operations/Netdata Cloud Visualizations"
9
--->
10
-
11
-# See an overview of your infrastructure
12
-
13
-In Netdata Cloud, your nodes are organized into War Rooms. One of the two available views for a War Room is the
14
-[**Overview**](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md), which uses composite charts to display
15
-real-time, aggregated metrics from all the nodes (or a filtered selection) in a given War Room.
16
-
17
-With Overview's composite charts, you can see your infrastructure from a single pane of glass, discover trends or
18
-anomalies, then drill down with filtering or single-node dashboards to see more. In the screenshot below,
19
-each chart visualizes average or sum metrics values from across 5 distributed nodes.
20
-
21
-Netdata also supports robust Kubernetes monitoring using the Overview. Read our [deployment
22
-doc](https://github.com/netdata/netdata/blob/master/packaging/installer/methods/kubernetes.md) for details on visualizing Kubernetes metrics in Netdata Cloud.
23
-
24
-
26
-
27
-## Using the Overview
28
-
29
-The Overview uses roughly the same interface as local Agent dashboards or single-node dashboards in Netdata Cloud. By
30
-showing all available metrics from all your nodes in a single interface, Netdata Cloud helps you visualize the overall
31
-health of your infrastructure. Best of all, you don't have to worry about creating your own dashboards just to get
32
-started with infrastructure monitoring.
33
-
34
-Let's walk through some examples of using the Overview to monitor and troubleshoot your infrastructure.
35
-
36
-### Filter nodes and pick relevant times
37
-
38
-While not exclusive to Overview, you can use two important features, [node
39
-filtering](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/node-filter.md) and the [time & date
40
-picker](https://github.com/netdata/netdata/blob/master/docs/dashboard/visualization-date-and-time-controls.md), to widen or narrow your infrastructure
41
-monitoring focus.
42
-
43
-By default, the Overview shows composite charts aggregated from every node in the War Room, but you can change that
44
-behavior on an ad-hoc basis. The node filter allows you to create complex queries against your infrastructure based on
45
-the name, OS, or services running on nodes. For example, use `(name contains aws AND os contains ubuntu) OR services ==
46
-apache` to show only nodes that have `aws` in the hostname and are Ubuntu-based, or any nodes that have an Apache
47
-webserver running on them.
48
-
49
-The time & date picker helps you visualize both small and large timeframes depending on your goals, whether that's
50
-establishing a baseline of infrastructure performance or targeted root cause analysis of a specific anomaly.
51
-
52
-For example, use the **Quick Selector** options to pick the 12-hour option first thing in the morning to check your
53
-infrastructure for any odd behavior overnight. Use the 7-day option to observe trends between various days of the week.
54
-
55
-See the [War Rooms](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/organize-your-infrastrucutre-invite-your-team.md#netdata-cloud-war-rooms) docs for more details on both features.
56
-
57
-### Configure composite charts to identify problems
58
-
59
-Let's say you notice a sharp decrease in available RAM for applications, as seen in the example screenshot below. In
60
-this situation, you can see when the anomalous behavior began and that it affects the average available and committed
61
-RAM across your infrastructure. However, when _grouped by dimension_, composite charts cannot show whether an anomaly
62
-affects a single node, a subset of nodes, or an entire infrastructure.
63
-
64
-
66
-
67
-Use [_group by node_](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md#group-by-dimension-or-node) to visualize
68
-a single metric across all contributing nodes. If the composite chart has 5 contributing nodes, there will be 5
69
-lines/areas, one for the most relevant dimension from each node.
70
-
71
-
73
-
74
-After grouping by node, it's clear that the `Composite-Charts-01` node is experiencing anomalous behavior and should be
75
-investigated further by jumping to its [single-node dashboard](#drill-down-with-single-node-dashboards) in Netdata
76
-Cloud.
77
-
78
-### Drill down with single-node dashboards
79
-
80
-Click on **X Charts** of any composite chart's definition bar to display a dropdown of contributing contexts and nodes
81
-contributing. Click on the link icon <img class="img__inline img__inline--link"
82
-src="https://user-images.githubusercontent.com/1153921/95762109-1d219300-0c62-11eb-8daa-9ba509a8e71c.png" /> next to a
83
-given node to quickly _jump to the same chart in that node's single-node dashboard_ in Netdata Cloud.
84
-
85
-You can use single-node dashboards in Netdata Cloud to drill down on specific issues, scrub backward in time to
86
-investigate historical data, and see like metrics presented meaningfully to help you troubleshoot performance problems.
87
-All of the familiar [interactions](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md) are available, as is adding any chart
88
-to a [new dashboard](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/dashboards.md).
89
-
90
-## Nodes tab
91
-
92
-You can also use the **Nodes tab** to monitor the health status and user-configurable key metrics from multiple nodes
93
-in a War Room. Read the [Nodes tab documentation](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md) for details.
94
-
95
-
packaging/installer/methods/ansible.md
+2
-2
@@ -103,8 +103,8 @@ two different SSH keys supplied by AWS.
103
104
### Edit the `vars/main.yml` file
105
106
-In order to connect your node(s) to your Space in Netdata Cloud, and see all their metrics in real-time in [composite
107
-charts](https://github.com/netdata/netdata/blob/master/docs/visualize/overview-infrastructure.md) or perform [Metric
106
+In order to connect your node(s) to your Space in Netdata Cloud, and see all their metrics in real-time in composite
107
+charts or perform [Metric
108
Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md), you need to set the `claim_token`
109
and `claim_room` variables.
110