Organize information from war-rooms.md to its correct location (#14729)
* Update war-rooms.md * update war-rooms.md * some visual fixes * Apply suggestions from code review Co-authored-by: Chris Akritidis <43294513+cakrit@users.noreply.github.com> * put info in the proper place from war-rooms.md * Update the images in visualization-date-and-time-controls.md * Apply suggestions from code review --------- Co-authored-by: Chris Akritidis <43294513+cakrit@users.noreply.github.com>
Fotis Voutsas committed
Mar 17, 2023 at 16:04 UTC
c803824aa277aa34b36192e7d23a4e4fa2fc46f7
4 files changed
+107
-156
docs/cloud/visualize/node-filter.md
new
+25
@@ -0,0 +1,25 @@
1
+# Node filter
2
+
3
+The node filter allows you to quickly filter the nodes visualized in a War Room's views.
4
+It appears on all views, except on single-node dashboards.
5
+
6
+Inside the filter, the nodes get categorized into three groups:
7
+
8
+- Live nodes
9
+ Nodes that are currently online, collecting and streaming metrics to Cloud.
10
+ - Live nodes display
11
+ raised [Alert](https://github.com/netdata/netdata/blob/master/docs/monitor/view-active-alarms.md) counters,
12
+ [Machine Learning](https://github.com/netdata/netdata/blob/master/ml/README.md) availability,
13
+ and [Functions](https://github.com/netdata/netdata/blob/master/docs/cloud/netdata-functions.md) availability
14
+- Stale nodes
15
+ Nodes that are offline and not streaming metrics to Cloud. Only historical data can be presented from a parent node.
16
+ - For these nodes you can only see their ML status, as they are not online to provide more information
17
+- Offline nodes
18
+ Nodes that are offline, not streaming metrics to Cloud and not available in any parent node.
19
+ Offline nodes are automatically deleted after 30 days and can also be deleted manually.
20
+
21
+By using the search bar, you can narrow down to specific nodes based on their name.
22
+
23
+When you select one or more nodes, the total selected number will appear in the **Nodes** bar on the **Selected** field.
24
+
25
+
docs/cloud/war-rooms.md
+30
-121
@@ -3,150 +3,59 @@
3
War Rooms organize your connected nodes and provide infrastructure-wide dashboards using real-time metrics and
4
visualizations.
5
6
-Once you add nodes to a Space, all of your nodes will be visible in the _All nodes_ War Room. This is a special War Room
7
-which gives you an overview of all of your nodes in this particular space. Then you can create functional separations of
6
+Once you add nodes to a Space, all of your nodes will be visible in the **All nodes** War Room. This is a special War Room
7
+which gives you an overview of all of your nodes in this particular Space. Then you can create functional separations of
8
your nodes into more War Rooms. Every War Room has its own dashboards, navigation, indicators, and management tools.
9
10
-
11
-
12
-## Navigation
13
-
14
-### Switching between views - static tabs
15
-
16
-Every War Rooms provides multiple views. Each view focus on a particular area/subject of the nodes which you monitor in
17
-this War Rooms. Let's explore what view you have available:
18
-
19
-- The default view for any War Room is
20
- the [Home tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md#home), which give you
21
- an overview
22
- of this space. Here you can see the number of Nodes claimed, data retention statics, user particate, alerts and more
23
-
24
-- The second and most important view is
25
- the [Overview tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md#overview) which
26
- uses composite
27
- charts to display real-time metrics from every available node in a given War Room.
28
-
29
-- The [Nodes tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md) gives you the ability to
30
- see the status (offline or online), host details
31
- , alarm status and also a short overview of some key metrics from all your nodes at a glance.
32
-
33
-- [Kubernetes tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/kubernetes.md) is a logical
34
- grouping of charts regards to your Kubernetes clusters.
35
- It contains a subset of the charts available in the _Overview tab_
36
-
37
--
38
-
39
-The [Dashboards tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/dashboards.md)
40
-gives you the ability to have tailored made views of
41
-specific/targeted interfaces for your infrastructure using any number of charts from any number of nodes.
42
-
43
-- The **Alerts tab** provides you with an overview for all the active alerts you receive for the nodes in this War Room,
44
- you can also see alla the alerts that are configured to be triggered in any given moment.
45
-
46
-- The **Anomalies tab** is dedicated to
47
- the [Anomaly Advisor](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/anomaly-advisor.md) tool
48
-
49
-### Non static tabs
50
-
51
-If you open
52
-a [new dashboard](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/dashboards.md),
53
-jump to a single-node dashboard, or navigate to a dedicated alert page they will open in a new War Room tab.
54
-
55
-Tabs can be rearranged with drag-and-drop or closed with the **X** button. Open tabs persist between sessions, so you
56
-can always come right back to your preferred setup.
57
-
58
-### Play, pause, force play, and timeframe selector
59
-
60
-A War Room has three different states: playing, paused, and force playing. The default playing state refreshes charts
61
-every second as long as the browser tab is in
62
-focus. [Interacting with a chart](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md)
63
-pauses
64
-the War Room. Once the tab loses focus, charts pause automatically.
65
-
66
-The top navigation bar features a play/pause button to quickly change the state, and a dropdown to select **Force Play**
67
-, which keeps charts refreshing, potentially at the expense of system performance.
68
-
69
-Next to the play/pause button is the timeframe selector, which helps you select a precise window of metrics data to
70
-visualize. By default, all visualizations in Netdata Cloud show the last 15 minutes of metrics data.
71
-
72
-Use the **Quick Selector** to visualize metrics from predefined timeframes, or use the input field below to enter a
73
-number and an appropriate unit of time. The calendar allows you to select multiple days of metrics data.
74
-
75
-Click **Apply** to re-render all visualizations with new metrics data streamed to your browser from each distributed
76
-node. Click **Clear** to remove any changes and apply the default 15-minute timeframe.
77
-
78
-The fields beneath the calendar display the beginning and ending timestamps your selected timeframe.
79
-
80
-### Node filter
81
-
82
-The node filter allows you to quickly filter the nodes visualized in a War Room's views. It appears on all views, but
83
-not on single-node dashboards.
84
-
85
-
10
+
11
12
## War Room organization
13
14
We recommend a few strategies for organizing your War Rooms.
15
91
-**Service, purpose, location, etc.**: You can group War Rooms by a service (think Nginx, MySQL, Pulsar, and so on),
92
-their purpose (webserver, database, application), their physical location, whether they're baremetal or a Docker
93
-container, the PaaS/cloud provider it runs on, and much more. This allows you to see entire slices of your
94
-infrastructure by moving from one War Room to another.
16
+- **Service, purpose, location, etc.**
17
+ You can group War Rooms by a service (Nginx, MySQL, Pulsar, and so on), their purpose (webserver, database, application), their physical location, whether they're "bare metal" or a Docker container, the PaaS/cloud provider it runs on, and much more.
18
+ This allows you to see entire slices of your infrastructure by moving from one War Room to another.
19
96
-**End-to-end apps/services**: If you have a user-facing SaaS product, or an internal service that said product relies
97
-on, you may want to monitor that entire stack in a single War Room. This might include Kubernetes clusters, Docker
98
-containers, proxies, databases, web servers, brokers, and more. End-to-end War Rooms are valuable tools for ensuring the
99
-health and performance of your organization's essential services.
20
+- **End-to-end apps/services**
21
+ If you have a user-facing SaaS product, or an internal service that this said product relies on, you may want to monitor that entire stack in a single War Room. This might include Kubernetes clusters, Docker containers, proxies, databases, web servers, brokers, and more.
22
+ End-to-end War Rooms are valuable tools for ensuring the health and performance of your organization's essential services.
23
101
-**Incident response**: You can also create new War Rooms as one of the first steps in your incident response process.
102
-For example, you have a user-facing web app that relies on Apache Pulsar for a message queue, and one of your nodes
103
-using the [Pulsar collector](https://github.com/netdata/go.d.plugin/blob/master/modules/pulsar/README.md) begins
104
-reporting a suspiciously low messages rate. You can create a War Room called `$year-$month-$day-pulsar-rate`, add all
105
-your Pulsar nodes in addition to nodes they connect to, and begin diagnosing the root cause in a War Room optimized for
106
-getting to resolution as fast as possible.
24
+- **Incident response**
25
+ You can also create new War Rooms as one of the first steps in your incident response process.
26
+ For example, you have a user-facing web app that relies on Apache Pulsar for a message queue, and one of your nodes using the [Pulsar collector](https://github.com/netdata/go.d.plugin/blob/master/modules/pulsar/README.md) begins reporting a suspiciously low messages rate.
27
+ You can create a War Room called `$year-$month-$day-pulsar-rate`, add all your Pulsar nodes in addition to nodes they connect to, and begin diagnosing the root cause in a War Room optimized for getting to resolution as fast as possible.
28
29
## Add War Rooms
30
110
-To add new War Rooms to any Space, click on the green plus icon **+** next the **War Rooms** heading. on the left (
111
-space's) sidebar.
31
+To add new War Rooms to any Space, click on the green plus icon **+** next the **War Rooms** heading on the left (Space's) sidebar.
32
113
-In the panel, give the War Room a name and description, and choose whether it's public or private. Anyone in your Space
114
-can join public War Rooms, but can only join private War Rooms with an invitation.
33
+In the panel, give the War Room a name and description, and choose whether it's public or private.
34
+Anyone in your Space can join public War Rooms, but can only join private War Rooms with an invitation.
35
36
## Manage War Rooms
37
118
-All the users and nodes involved in a particular space can potential be part of a War Room.
38
+All the users and nodes involved in a particular Space can be part of a War Room.
39
120
-Any user can change simple settings of a War room, like the name or the users participating in it. Click on the gear
121
-icon of the War Room's name in the top of the page to do that. A sidebar will open with options for this War Room:
40
+Any user can change simple settings of a War room, like the name or the users participating in it.
41
+Click on the gear icon of the War Room's name in the top of the page to do that. A sidebar will open with options for this War Room:
42
123
-1. To _change a War Room's name, description, or public/private status_, click on **War Room** tab of the sidebar.
43
+1. To **change a War Room's name, description, or public/private status**, click on **War Room** tab.
44
125
-2. To _include an existing node_ to a War Room or _connect a new node*_ click on **Nodes** tab of the sidebar. Choose
126
- any
127
- connected node you want to add to this War Room by clicking on the checkbox next to its hostname, then click **+ Add
128
- **
129
- at the top of the panel.
45
+2. To **include an existing node** to a War Room or **connect a new node\*** click on **Nodes** tab. Choose any connected node you want to add to this War Room by clicking on the checkbox next to its hostname, then click **+ Add** at the top of the panel.
46
131
-3. To _add existing users to a War Room_, click on **Add Users**. See
132
- our [invite doc](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/invite-your-team.md)
133
- for details on inviting new users to your Space in Netdata Cloud.
47
+3. To **add existing users to a War Room**, click on **Add Users**.
48
+ See our [invite doc](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/invite-your-team.md) for details on inviting new users to your Space in Netdata Cloud.
49
135
-:::note
136
-\* This action requires admin rights for this space
137
-:::
50
+> ### Note
51
+>
52
+>\* This action requires **admin** rights for this Space
53
54
### More actions
55
141
-To _view or remove nodes_ in a War Room, click on **Nodes view**. To remove a node from the current War Room, click on
56
+To **view or remove nodes** in a War Room, click on **Nodes view**. To remove a node from the current War Room, click on
57
the **🗑** icon.
58
144
-:::info
145
-Removing a node from a War Room does not remove it from your Space.
146
-:::
147
-
148
-## What's next?
149
-
150
-Once you've figured out an organizational structure that works for your team, learn more about how you can use Netdata
151
-Cloud to monitor distributed nodes
152
-using [real-time composite charts](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md).
59
+> ### Info
60
+>
61
+> Removing a node from a War Room does not remove it from your Space.
docs/dashboard/visualization-date-and-time-controls.md
+26
-26
@@ -3,21 +3,20 @@
3
## Time controls
4
5
The time control provides you the following options: **Play**, **Pause** and **Force Play**.
6
-* **Play** - the content of the page will be automatically refreshed while this is in the foreground
7
-* **Pause** - the content of the page isn't refreshed due to a manual request to pause it or, for example, when your investigating data on a
8
-chart (cursor is on top of a chart)
9
-* **Force Play** - the content of the page will be automatically refreshed even if this is in the background
6
11
-With this, we aim to bring more clarity and allow you to distinguish if the content you are looking at is live or historical and also allow you
12
- to always refresh the content of the page when the tabs are in the background.
7
+- **Play** - the content of the page will be automatically refreshed while this is in the foreground
8
+- **Pause** - the content of the page isn't refreshed due to a manual request to pause it or, for example, when your investigating data on a chart (cursor is on top of a chart)
9
+- **Force Play** - the content of the page will be automatically refreshed even if this is in the background
10
+
11
+With this, we aim to bring more clarity and allow you to distinguish if the content you are looking at is live or historical and also allow you to always refresh the content of the page when the tabs are in the background.
12
13
Main use cases for **Force Play**:
15
-* You use a terminal or deployment tools to do changes in your infra and want to see immediately, Netdata is in the background, displaying the impact
16
-of these changes
17
-* You want to have Netdata on the background, example displayed on a TV, to constantly see metrics through dashboards or to watch the alert
18
-status
14
20
-
15
+- You use a terminal or deployment tools to do changes in your infra and want to see the effect immediately, Netdata is in the background, displaying the impact of these changes
16
+- You want to have Netdata on the background, example displayed on a TV, to constantly see metrics through dashboards or to watch the alert status
17
+
18
+
19
+
20
21
## Date and time selector
22
@@ -25,43 +24,43 @@ The date and time selector allows you to change the visible timeframe and change
24
25
### Pick timeframes to visualize
26
28
-While [panning through time and zooming in/out](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md) from charts it is helpful when
29
-you're looking a recent history, or want to do granular troubleshooting, what if you want to see metrics from 6 hours
30
-ago? Or 6 days?
27
+While [panning through time and zooming in/out](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md) from charts it is helpful when you're looking a recent history, or want to do granular troubleshooting, what if you want to see metrics from 6 hours ago? Or 6 days?
28
29
Netdata's dashboard features a **timeframe selector** to help you visualize specific timeframes in a few helpful ways.
33
-By default, it shows a certain number of minutes of historical metrics based on the your browser's viewport to ensure
34
-it's always showing per-second granularity.
30
+By default, it shows a certain number of minutes of historical metrics based on the your browser's viewport to ensure it's always showing per-second granularity.
31
32
#### Open the timeframe selector
33
38
-To visualize a new timeframe, you need to open the picker, which appears just above the menu, near the top-right cover
39
-of the dashboard.
34
+To visualize a new timeframe, you need to open the picker, which appears just above the menu, near the top-right bar of the dashboard.
35
41
-
36
+
37
38
The **Clear** button resets the dashboard back to its default state based on your browser viewport, and **Apply** closes
39
the picker and shifts all charts to the selected timeframe.
40
47
-#### Use the Quick Selector
41
+#### Use the pre-defined timeframes
42
49
-Click any of the following options in the **Quick Selector** to choose a commonly-used timeframe.
43
+Click any of the following options in the predefined timeframe column to choose between:
44
45
- Last 5 minutes
46
- Last 15 minutes
47
+- Last 30 minutes
48
+- Last hour
49
- Last 2 hours
50
- Last 6 hours
51
- Last 12 hours
52
+- Last day
53
+- Last 2 days
54
+- Last 7 days
55
56
Click **Apply** to see metrics from your selected timeframe.
57
58
#### Choose a specific interval
59
61
-Beneath the Quick Selector is an input field and dropdown you use in combination to select a specific timeframe of
60
+Beneath the predefined timeframe columns is an input field and dropdown you use in combination to select a specific timeframe of
61
minutes, hours, days, or months. Enter a number and choose the appropriate unit of time, then click **Apply**.
62
64
-#### Choose multiple days
63
+#### Choose multiple days via the calendar
64
65
Use the calendar to select multiple days. Click on a date to begin the timeframe selection, then an ending date. The
66
timeframe begins at noon on the beginning and end dates. Click **Apply** to see your selected multi-day timeframe.
@@ -77,7 +76,8 @@ time-series database (TSDB) to store as many metrics as it can within a specific
76
storage is 256 MiB, which should be enough for 1-3 days of historical metrics. If you navigate back to a timeframe
77
beyond stored historical metrics, you'll see this message:
78
80
-
79
+
80
+
81
82
At any time, [configure the internal TSDB's storage capacity](https://github.com/netdata/netdata/blob/master/docs/store/change-metrics-storage.md) to expand your
83
depth of historical metrics.
@@ -87,4 +87,4 @@ depth of historical metrics.
87
The default timezone used in all date and time fields in Netdata Cloud comes from your browser. To change it, open the
88
date and time selector and use the control displayed here:
89
90
-<img alt="Untitled1" src="https://user-images.githubusercontent.com/43294513/216628390-c3bd1cd2-349d-4523-b8d3-c7e68395f670.png"/>
90
+
docs/quickstart/infrastructure.md
+26
-9
@@ -61,18 +61,35 @@ in](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/sign-in.md)
61
62
### See an overview of your infrastructure
63
64
-The default way to visualize the health and performance of an infrastructure with Netdata Cloud is the
65
-[**Overview**](https://github.com/netdata/netdata/blob/master/docs/visualize/overview-infrastructure.md), which is the default interface of every War Room. The
66
-Overview features composite charts, which display aggregated metrics from every node in a given War Room. These metrics
67
-are streamed on-demand from individual nodes and composited onto a single, familiar dashboard.
64
+Netdata Cloud utilizes "tabs" in order to provide you with informative sections based on your infrastructure.
65
+These tabs can be separated into "static", meaning they are by default presented, and "non-static" which are tabs that get presented by user action (e.g clicking on a custom dashboard)
66
69
-
67
+#### Static tabs
68
72
-Read more about the Overview in the [infrastructure overview](https://github.com/netdata/netdata/blob/master/docs/visualize/overview-infrastructure.md) doc.
69
+- The default view for any War Room is the [Home tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md#home), which gives you an overview of this Space.
70
+ Here you can see the number of Nodes claimed, data retention statics, users by role, alerts and more.
71
74
-Netdata Cloud also features the [**Nodes view**](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/nodes.md), which you can
75
-use to configure and see a few key metrics from every node in the War Room, view health status, and more.
72
+- The second and most important view 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.
73
+
74
+- 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, alarm status and also a short overview of some key metrics from all your nodes at a glance.
75
+
76
+- [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**.
77
+
78
+- The [Dashboards tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/dashboards.md) gives you the ability to have tailored made views of specific/targeted interfaces for your infrastructure using any number of charts from any number of nodes.
79
+
80
+- The [Alerts tab](https://github.com/netdata/netdata/blob/master/docs/monitor/view-active-alarms.md) provides you with an overview for all the active alerts you receive for the nodes in this War Room, you can also see all the alerts that are configured to be triggered in any given moment.
81
+
82
+- The [Anomalies tab](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/anomaly-advisor.md) is dedicated to the Anomaly Advisor tool.
83
+
84
+- The [Functions tab](https://github.com/netdata/netdata/blob/master/docs/cloud/netdata-functions.md) gives you the ability to visualize functions that the Netdata Agent collectors are able to expose.
85
+
86
+- The [Feed & events](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/events-feed.md) tab lets you investigate events that occurred in the past, which is invaluable for troubleshooting.
87
+
88
+#### Dynamic tabs
89
+
90
+If you open a [new dashboard](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/dashboards.md), jump to a single-node dashboard, or navigate to a dedicated alert page, a new tab will open in War Room bar.
91
+
92
+Tabs can be rearranged with drag-and-drop or closed with the **X** button. Open tabs persist between sessions, so you can always come right back to your preferred setup.
93
94
### Drill down to specific nodes
95