Add documentation for Cloud Overview (#10082)
* First pass on Overview revisions * Finish up draft of infra doc with Overview * Rename UI element * Tweak to Graphite doc * Copyedit pass * Fixes for Amy
Joel Hans committed
Oct 21, 2020 at 05:45 UTC
d0634981533990aa6f4aec2368bb54ef081946be
7 files changed
+182
-113
docs/configure/secure-nodes.md
+1
-1
@@ -37,7 +37,7 @@ that align with your goals and your organization's standards.
37
## Disable the local dashboard
38
39
This is the _recommended method for those who have claimed their nodes to Netdata Cloud_ and prefer viewing real-time
40
-metrics using the Nodes view and Cloud dashboards.
40
+metrics using the War Room Overview, Nodes view, and Cloud dashboards.
41
42
You can disable the local dashboard (and API) but retain the encrypted Agent-Cloud link ([ACLK](/aclk/README.md)) that
43
allows you to stream metrics on demand from your nodes via the Netdata Cloud interface. This change mitigates all
docs/guides/export/export-netdata-metrics-graphite.md
+3
-3
@@ -165,9 +165,9 @@ You can also show these exporting engine metrics on Netdata Cloud. If you don't
165
in](https://app.netdata.cloud) and get started for free. If you need some help along the way, read the [get started with
166
Cloud guide](https://learn.netdata.cloud/docs/cloud/get-started).
167
168
-Add more metrics to the Nodes view by clicking on the **Add metric** button, then typing `exporting` into the context
169
-field. Choose the exporting contexts you want to add, then click **Add**. You'll see these charts alongside any others
170
-you've customized in Netdata Cloud.
168
+Add more metrics to a War Room's Nodes view by clicking on the **Add metric** button, then typing `exporting` into the
169
+context field. Choose the exporting contexts you want to add, then click **Add**. You'll see these charts alongside any
170
+others you've customized in Netdata Cloud.
171
172
docs/guides/troubleshoot/monitor-debug-applications-ebpf.md
+4
-4
@@ -236,10 +236,10 @@ If you don't already have a Netdata Cloud account, go [sign in](https://app.netd
236
Read the [get started with Cloud guide](https://learn.netdata.cloud/docs/cloud/get-started) for a walkthrough of node
237
claiming and other fundamentals.
238
239
-Add more charts to the Nodes view by clicking on the gear icon at the far end of the table. Click on the **Context**
240
-input and scroll until you find the eBPF chart you're interested in, or type in the name of the context directly. Maybe
241
-something like `apps.vfs_write_call`? Next, click on the **Dimensions** input and find the `dev` dimension, or maybe
242
-`apache`/`redis` if you set your `apps_groups.conf` up like the examples above.
239
+Add more charts to a War Room's Overview, or the Nodes view, by clicking on the gear icon at the far end of the table.
240
+Click on the **Context** input and scroll until you find the eBPF chart you're interested in, or type in the name of the
241
+context directly. Maybe something like `apps.vfs_write_call`? Next, click on the **Dimensions** input and find the `dev`
242
+dimension, or maybe `apache`/`redis` if you set your `apps_groups.conf` up like the examples above.
243
244
Click **Save** to add the chart for all your claimed nodes. Now you can see how your application interacts with multiple
245
Linux kernels on multiple Linux systems.
docs/quickstart/infrastructure.md
+36
-26
@@ -27,41 +27,49 @@ nodes and get helpful pointers about collecting all the metrics from every criti
27
> those nodes to your Space in Netdata Cloud. If you haven't yet, see the [_Get Netdata_ doc](/docs/get/README.md) for
28
> details on installation and claiming.
29
30
-## See your infrastructure's metrics
30
+> If you want to monitor a Kubernetes cluster with Netdata, see our [k8s installation
31
+> doc](/packaging/installer/methods/kubernetes.md) for setup details, and then read our guide, [_Monitor a Kubernetes
32
+> cluster with Netdata_](/docs/guides/monitor/kubernetes-k8s-netdata.md).
33
+
34
+## See an overview of your infrastructure
35
36
To see all your nodes from a single pane of glass, first [sign in](https://app.netdata.cloud) to Netdata Cloud. As you
33
-sign in, Netdata Cloud pings each claimed node to start on-demand streaming from your nodes to your browser. When
34
-Netdata Cloud loads your War Room's **Nodes** view, you'll immediately see key metrics from your nodes, streamed in
35
-real time, in a single interface.
37
+navigate to a particular War Room, Netdata Cloud pings each claimed node to start on-demand streaming from your nodes to
38
+your browser.
39
37
-
40
+Netdata Cloud then visualizes all these metrics, from any number of distributed nodes, in the War Room's **Overview**.
41
+The Overview features composite charts, which display aggregated metrics from multiple nodes.
42
40
-You can drill down into any node's full dashboard by clicking on that node's hostname in the Nodes view.
43
+
45
42
-
46
+Netdata Cloud also features the **Nodes view**, which you can use to configure and see a few key metrics from every node
47
+in the War Room, view health status, and more.
48
45
-You can use single-node dashboards in Netdata Cloud to drill down on specific issues, scrub backward in time to
46
-investigate historical data, and see like metrics presented meaningfully to help you troubleshoot performance problems.
47
-Learn about [interacting with dashboards and charts](/docs/visualize/interact-dashboards-charts.md) to get the most from
48
-all of Netdata's real-time metrics.
49
+
50
50
-> If you want to monitor a Kubernetes cluster with Netdata, see our [k8s installation
51
-> doc](/packaging/installer/methods/kubernetes.md) for setup details, and then read our guide, [_Monitor a Kubernetes
52
-> cluster with Netdata_](/docs/guides/monitor/kubernetes-k8s-netdata.md).
51
+Read more about both features in the [infrastructure overview](/docs/visualize/overview-infrastructure.md) doc.
52
54
-## Build new dashboards for your infrastructure
53
+## Drill down to specific nodes
54
56
-You can use Netdata Cloud to build new dashboards that match your infrastructure's topology or help you diagnose complex
57
-issues by aggregating correlated charts from any number of nodes.
55
+Both the Overview and Nodes view offer easy access to **single-node dashboards** for targeted analysis. You can use
56
+single-node dashboards in Netdata Cloud to drill down on specific issues, scrub backward in time to investigate
57
+historical data, and see like metrics presented meaningfully to help you troubleshoot performance problems.
58
59
-To build your first dashboard, click on the **Nodes** dropdown, then select **+ Add**. Enter a name to assign to this
60
-dashboard. Click on either of the **Add chart** buttons, then select the node you want to add a chart from. Select the
61
-context, which is Netdata's way to organize charts, and then click **Add chart**.
59
+Read about the process in the [infrastructure
60
+overview](/docs/visualize/overview-infrastructure.md#single-node-dashboards) doc, then learn about [interacting with
61
+dashboards and charts](/docs/visualize/interact-dashboards-charts.md) to get the most from all of Netdata's real-time
62
+metrics.
63
63
-Once you add a few charts, you can move them around, resize them, and add text. Make sure you click the **Save** button
64
-before you navigate away.
64
+## Create new dashboards
65
+
66
+You can use Netdata Cloud to create new dashboards that match your infrastructure's topology or help you diagnose
67
+complex issues by aggregating correlated charts from any number of nodes. For example, you could monitor the system CPU
68
+from every node in your infrastructure on a single dashboard.
69
+
70
+
72
+)
73
74
Read more about [creating new dashboards](/docs/visualize/create-dashboards.md) for more details about the process and
75
additional tips on best leveraging the feature to help you troubleshoot complex performance problems.
@@ -114,10 +122,10 @@ Once you have a handle on configuration and are collecting all the right metrics
122
infrastructure-focused features:
123
124
- [Organize your nodes](/docs/configure/spaces-war-rooms.md) into **War Rooms** based on your preferred strategy.
125
+- [See an overview of your infrastructure](/docs/visualize/overview-infrastructure.md) using Netdata Cloud's various
126
+ preconfigured dashboards.
127
- [Invite your team](/docs/configure/invite-collaborate.md) to collaborate on identifying anomalies or troubleshooting
128
complex performance problems.
119
-- [Export metrics](/docs/export/external-databases.md) to an external time-series database to use Netdata alongside
120
- other monitoring and troubleshooting tools.
129
130
To change how the Netdata Agent runs on each node, dig in to configuration files:
131
@@ -127,5 +135,7 @@ To change how the Netdata Agent runs on each node, dig in to configuration files
135
- [Create new alarms](/docs/monitor/configure-alarms.md), or tweak some of the pre-configured alarms, to stay on top
136
of anomalies.
137
- [Enable notifications](/docs/monitor/enable-notifications.md) to Slack, PagerDuty, email, and 30+ other services.
138
+- [Export metrics](/docs/export/external-databases.md) to an external time-series database to use Netdata alongside
139
+ other monitoring and troubleshooting tools.
140
141
[](<>)
docs/visualize/interact-dashboards-charts.md
+16
-2
@@ -67,8 +67,9 @@ charts](https://user-images.githubusercontent.com/1153921/93497197-071fed00-f8c5
67
These interactions can also be triggered using the icons on the bottom-right corner of every chart. They are,
68
respectively, `Pan Left`, `Reset`, `Pan Right`, `Zoom In`, and `Zoom Out`.
69
70
-You can show and hide individual dimensions by clicking on their names. Hiding dimensions simplifies the chart and can
71
-help you better discover exactly which aspect of your system is behaving strangely.
70
+You can show and hide individual dimensions by clicking on their names. Use `SHIFT + click` to hide or show dimensions
71
+one at a time. Hiding dimensions simplifies the chart and can help you better discover exactly which aspect of your
72
+system is behaving strangely.
73
74
You can resize any chart by clicking-and-dragging the icon on the bottom-right corner of any chart. To restore the chart
75
to its original height, double-click the same icon.
@@ -76,6 +77,13 @@ to its original height, double-click the same icon.
77
79
80
+### Composite charts in Netdata Cloud
81
+
82
+Netdata Cloud now supports composite charts in the Overview interface. Composite charts come with a few additional UI
83
+elements and varied interactions, such as the location of dimensions and a utility bar for configuring the state of
84
+individual composite charts. All of these de4tails are covered in the [Overview
85
+reference](https://learn.netdata.cloud/docs/cloud/visualize/overview) doc.
86
+
87
## What's next?
88
89
Netdata Cloud users can [build new dashboards](/docs/visualize/create-dashboards.md) in just a few clicks. By
@@ -86,4 +94,10 @@ If you're finished with dashboards for now, skip to Netdata's health watchdog fo
94
configuring](/docs/monitor/configure-alarms.md) alarms, and [send notifications](/docs/monitor/enable-notifications.md)
95
to get informed when something goes wrong in your infrastructure.
96
97
+### Related reference documentation
98
+
99
+- [Netdata Agent · Web dashboards overview](/web/README.md)
100
+- [Netdata Cloud · War Rooms](https://learn.netdata.cloud/docs/cloud/war-rooms)
101
+- [Netdata Cloud · Overview](https://learn.netdata.cloud/docs/cloud/visualize/overview)
102
+
103
[](<>)
docs/visualize/overview-infrastructure.md
new
+122
@@ -0,0 +1,122 @@
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
+-->
6
+
7
+# See an overview of your infrastructure
8
+
9
+In Netdata Cloud, your nodes are organized into War Rooms. One of the two available views for a War Room is the
10
+**Overview**, which uses composite charts to display real-time, aggregated metrics from all the nodes (or a filtered
11
+selection) in a given War Room.
12
+
13
+With Overview's composite charts, you can see your infrastructure from a single pane of glass, discover trends or
14
+anomalies, then drill down with filtering or single-node dashboards to see more. In the screenshot below,
15
+each chart visualizes average or sum metrics values from across 5 distributed nodes.
16
+
17
+
19
+
20
+## Using the Overview
21
+
22
+> ⚠️ In order for nodes to contribute to composite charts, and thus the Overview UI, they must run v1.26.0 or later of
23
+> the Netdata Agent. See our [update docs](/docs/agent/packaging/installer/update) for the preferred update method based
24
+> on how you installed the Agent.
25
+
26
+The Overview uses roughly the same interface as local Agent dashboards or single-node dashboards in Netdata Cloud. By
27
+showing all available metrics from all your nodes in a single interface, Netdata Cloud helps you visualize the overall
28
+health of your infrastructure. Best of all, you don't have to worry about creating your own dashboards just to get
29
+started with infrastructure monitoring.
30
+
31
+Let's walk through some examples of using the Overview to monitor and troubleshoot your infrastructure.
32
+
33
+### Filter nodes and pick relevant times
34
+
35
+While not exclusive to Overview, you can use two important features, [node
36
+filtering](https://learn.netdata.cloud/docs/cloud/war-rooms#node-filter) and the [time & date
37
+picker](https://learn.netdata.cloud/docs/cloud/war-rooms#time--date-picker), to widen or narrow your infrastructure
38
+monitoring focus.
39
+
40
+By default, the Overview shows composite charts aggregated from every node in the War Room, but you can change that
41
+behavior on an ad-hoc basis. The node filter allows you to create complex queries against your infrastructure based on
42
+the name, OS, or services running on nodes. For example, use `(name contains aws AND os contains ubuntu) OR services ==
43
+apache` to show only nodes that have `aws` in the hostname and are Ubuntu-based, or any nodes that have an Apache
44
+webserver running on them.
45
+
46
+The time & date picker helps you visualize both small and large timeframes depending on your goals, whether that's
47
+establishing a baseline of infrastructure performance or targeted root cause analysis of a specific anomaly.
48
+
49
+For example, use the **Quick Selector** options to pick the 12-hour option first thing in the morning to check your
50
+infrastructure for any odd behavior overnight. Use the 7-day option to observe trends between various days of the week.
51
+
52
+See the [War Rooms](https://learn.netdata.cloud/docs/cloud/war-rooms) docs for more details on both features.
53
+
54
+### Configure composite charts to identify problems
55
+
56
+Let's say you notice an interesting spike in disk I/O between `14:42:56` and `14:47:08`. Highlight the anomalous area
57
+using `ALT/⌘ + mouse selection`, then zoom in with `SHIFT + mouse selection` to synchronize all composite charts around
58
+this potentially problematic area.
59
+
60
+
62
+
63
+By default, the **Disk I/O Bandwidth (disk.io)** composite chart displays the **sum** of all dimensions (`reads` and
64
+`writes`) from all nodes in that War Room. This smart default helps you identify anomalous behavior, but doesn't
65
+necessarily provide the full picture. Let's say you want to understand the severity of disk writes. Use the definition
66
+bar to change the aggregate function to **min** (because the `writes` dimension is on the negative axis), and display
67
+only the `writes` dimension.
68
+
69
+
71
+
72
+Because you're now looking at the largest magnitude of change on your infrastructure, you know a single node experienced
73
+31 MiB/s in disk writes. By first using the Overview to gather baseline data, identify anomalies, and use aggregate
74
+functions to your advantage, you've proactively recognized single-node issues using an infrastructure-wide interface.
75
+
76
+### Drill down to single-node dashboards
77
+
78
+Overview helps you take the investigation further with quick access to single-node dashboards in Netdata Cloud.
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
+)
87
+
88
+You can use single-node dashboards in Netdata Cloud to drill down on specific issues, scrub backward in time to
89
+investigate historical data, and see like metrics presented meaningfully to help you troubleshoot performance problems.
90
+All of the familiar [interactions](/docs/visualize/interact-dashboards-charts.md) are available, as is adding any chart
91
+to a [new dashboard](/docs/visualize/create-dashboards.md).
92
+
93
+Using the above example, one of the single-node dashboards reveals similar spike in disk I/O. Interestingly enough, it
94
+also shows a maximum disk write of 31 MiB/s at the exact same moment as the composite chart in Overview.
95
+
96
+
98
+
99
+You now know that this particular node, during this particular time, experienced anomalous behavior. In this case, the
100
+root cause of the disk I/O spike was due to updating the Netdata Agent itself, which is also the cause of the subsequent
101
+gap in metrics history.
102
+
103
+## Nodes view
104
+
105
+You can also use the **Nodes view** to monitor the health status and user-configurable key metrics from multiple nodes
106
+in a War Room. Read the [Nodes view doc](https://learn.netdata.cloud/docs/cloud/visualize/nodes) for details.
107
+
108
+
109
+
110
+## What's next?
111
+
112
+To troubleshoot complex performance issues using Netdata, you need to understand how to interact with its meaningful
113
+visualizations. Learn more about [interaction](/docs/visualize/interact-dashboards-charts.md) to see historical metrics,
114
+highlight timeframes for targeted analysis, and more.
115
+
116
+### Related reference documentation
117
+
118
+- [Netdata Cloud · War Rooms](https://learn.netdata.cloud/docs/cloud/war-rooms)
119
+- [Netdata Cloud · Overview](https://learn.netdata.cloud/docs/cloud/visualize/overview)
120
+- [Netdata Cloud · Nodes view](https://learn.netdata.cloud/docs/cloud/visualize/nodes-view)
121
+
122
+[](<>)
docs/visualize/view-all-nodes.md
deleted
-77
@@ -1,77 +0,0 @@
1
-<!--
2
-title: "View all nodes at a glance"
3
-description: "With Netdata Cloud's War Rooms, you can see the health status and real-time key metrics from any number of nodes in your infrastructure."
4
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/visualize/view-all-nodes.md
5
--->
6
-
7
-# View all nodes at a glance
8
-
9
-In Netdata Cloud, your nodes are organized into War Rooms. The default view for any War Room is called the **Nodes
10
-view**, which lets you see the health, performance, and alarm status of a particular cross-section of your
11
-infrastructure.
12
-
13
-Each node occupies a single row, first featuring that node's alarm status (yellow for warnings, red for critical alarms)
14
-and operating system, some essential information about the node, followed by any number of user-defined columns for key
15
-metrics.
16
-
17
-Click on the hostname of any node to seamlessly navigate to that node's Cloud dashboard. From here, you will see all the
18
-same charts and real-time metrics as you would if you viewed the local dashboard at `http://NODE:19999`.
19
-
20
-
22
-
23
-By combining Nodes view with Cloud dashboards, you and your team can view all nodes at a glance, immediately identify
24
-anomalies with auto-updating health statuses and key metrics, then dive into individual dashboards for discovering the
25
-root cause.
26
-
27
-## Add and edit key metrics
28
-
29
-Customize any War Room by adding new key metrics or editing the existing ones. These customizations appear for anyone
30
-else with access to that War Room so that your entire team can troubleshoot from the same platform.
31
-
32
-Add more key metrics by clicking the gear icon in the Nodes view. Choose the context you'd like to add, give it a
33
-relevant name, and select whether you want to see all dimensions (the default), or only the specific dimensions your
34
-team is interested in.
35
-
36
-
38
-
39
-To edit existing key metrics, click the gear icon, then the pencil icon. Use the panel to edit that metric's context or
40
-title, add or remove dimension, or delete the chart altogether.
41
-
42
-## Change the timeframe
43
-
44
-By default, the Nodes view shows the last 5 minutes of metrics data on every chart. The value displayed above the chart
45
-is the 5-minute average of those metrics.
46
-
47
-Change the timeframe, and also change both the charts and the average value, by clicking on any of the buttons
48
-next to the **Last** label. **15m** will display the last 15 minutes of metrics for each chart, **30m** for 30 minutes,
49
-and so on.
50
-
51
-
53
-
54
-## Filter and group your infrastructure
55
-
56
-Use the filter input next to the Nodes heading to filter the nodes in a given War Room. The filtering feature supports
57
-relational operators (`==`, `!=`, `contains`, and `!contains`) and logical operators (`AND`, `OR`), plus the name, OS,
58
-or services running on your nodes to quickly turn any War Room into a focused troubleshooting interface. See what
59
-services Netdata Cloud can filter by in the [supported collectors list](/collectors/COLLECTORS.md).
60
-
61
-For example, `name == centos OR os == debian` filters any nodes by the exact name centos or has Debian as its operating
62
-system.
63
-
64
-You can also use parentheses around operators to create more sophisticated filters. `(name contains aws AND os contains
65
-ubuntu) OR services == apache` shows only nodes that have `aws` in the hostname and are Ubuntu-based, or any nodes that
66
-have an Apache webserver running on them.
67
-
68
-
70
-
71
-## What's next?
72
-
73
-To troubleshoot complex performance issues using Netdata, you need to understand how to interact with its meaningful
74
-visualizations. Learn more about [interaction](/docs/visualize/interact-dashboards-charts.md) to see historical metrics,
75
-highlight timeframes for targeted analysis, and more.
76
-
77
-[](<>)