Update chart documentation (#15010)
* initial update commit, organize info * wording changes * add screenshots and more info * small fix * small fix * Apply suggestions from code review Co-authored-by: Chris Akritidis <43294513+cakrit@users.noreply.github.com> * changes from review --------- Co-authored-by: Chris Akritidis <43294513+cakrit@users.noreply.github.com>
Fotis Voutsas committed
May 8, 2023 at 20:36 UTC
11e666e9ddcfc6ec2628f79f8931cc78279d1bde
1 file changed
+224
-180
docs/cloud/visualize/interact-new-charts.md
+224
-180
@@ -8,129 +8,136 @@ To make sense of all the metrics, Netdata offers an enhanced version of charts t
8
These charts provide a lot of useful information, so that you can:
9
10
- Enjoy the high-resolution, granular metrics collected by Netdata
11
-- Explore visualization with more options such as _line_, _stacked_ and _area_ types (other types like _bar_, _pie_ and
12
- _gauges_ are to be added shortly)
11
- Examine all the metrics by hovering over them with your cursor
14
-- Use intuitive tooling and shortcuts to pan, zoom or highlight your charts
15
-- On highlight, ease access
16
- to [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md) to
17
- see other metrics with similar patterns
12
+- Filter the metrics in any way you want using the [Definition bar](#definition-bar)
13
+- View the combined anomaly rate of all underlying data with the [Anomaly Rate ribbon](#anomaly-rate-ribbon)
14
+- Explore even more details about a chart's metrics through [hovering over certain elements of it](#hover-over-the-chart)
15
+- Use intuitive tooling and shortcuts to pan, zoom or highlight areas of interest in your charts
16
+- On highlight, get easy access to [Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md) to see other metrics with similar patterns
17
- Have the dimensions sorted based on name or value
18
- View information about the chart, its plugin, context, and type
20
-- Get the chart status and possible errors. On top, reload functionality
19
+- View individual metric collection status about a chart
20
22
-These charts are available on Netdata Cloud's
21
+These charts are available on Netdata Cloud's
22
[Overview tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md), Single Node tab and
23
on your [Custom Dashboards](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/dashboards.md).
24
26
-Some of the features listed below are also available on the simpler charts that are available on each agent's user interface.
27
-
25
## Overview
26
30
-Have a look at the can see the overall look and feel of the charts for both with a composite chart from
31
-the [Overview tab](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md) and a simple chart
32
-from the Single Node tab:
27
+A Netdata chart looks like this:
28
34
-<img width="678" alt="image" src="https://user-images.githubusercontent.com/43294513/220913360-f3f2ac06-b715-4e99-a933-f3bcb776636f.png"/>
29
+<img src="https://user-images.githubusercontent.com/70198089/236133212-353c102f-a6ed-45b7-9251-34e004c7a10a.png" width="900"/>
30
31
With a quick glance you have immediate information available at your disposal:
32
38
-- Chart title and units
39
-- Definition bar
40
-- Action bars
41
-- Chart area
42
-- Legend with dimensions
33
+- [Chart title and units](#title-bar)
34
+- [Anomaly Rate ribbon](#anomaly-rate-ribbon)
35
+- [Definition bar](#definition-bar)
36
+- [Tool bar](#tool-bar)
37
+- [Chart area](#hover-over-the-chart)
38
+- [Legend with dimensions](#dimensions-bar)
39
44
-## Play, Pause and Reset
40
+## Title bar
41
46
-Your charts are controlled using the available
47
-[Time controls](https://github.com/netdata/netdata/blob/master/docs/dashboard/visualization-date-and-time-controls.md#time-controls).
48
-Besides these, when interacting with the chart you can also activate these controls by:
42
+When you start interacting with a chart, you'll notice valuable information on the top bar:
43
50
-- Hovering over any chart to temporarily pause it - this momentarily switches time control to Pause, so that you can
51
- hover over a specific timeframe. When moving out of the chart time control will go back to Play (if it was it's
52
- previous state)
53
-- Clicking on the chart to lock it - this enables the Pause option on the time controls, to the current timeframe. This
54
- is if you want to jump to a different chart to look for possible correlations.
55
-- Double clicking to release a previously locked chart - move the time control back to Play
44
+<img src="https://user-images.githubusercontent.com/70198089/236133832-fad45e65-5bd6-4fd1-8d68-33acf69fff5c.png" width="900"/>
45
57
-| Interaction | Keyboard/mouse | Touchpad/touchscreen | Time control |
58
-|:------------------|:---------------|:---------------------|:----------------------|
59
-| **Pause** a chart | `hover` | `n/a` | Temporarily **Pause** |
60
-| **Stop** a chart | `click` | `tap` | **Pause** |
61
-| **Reset** a chart | `double click` | `n/a` | **Play** |
46
+The elements that you can find on this top bar are:
47
63
-Note: These interactions are available when the default "Pan" action is used. Other actions are accessible via
64
-the [Exploration action bar](#exploration-action-bar).
48
+- **Netdata icon**: this indicates that data is continuously being updated, this happens if [Time controls](https://github.com/netdata/netdata/blob/master/docs/dashboard/visualization-date-and-time-controls.md#time-controls) are in Play or Force Play mode.
49
+- **Chart title**: on the chart title you can see the title together with the metric being displayed, as well as the unit of measurement.
50
+- **Chart status icon**: possible values are: Loading, Timeout, Error or No data, otherwise this icon is not shown.
51
66
-## Title and chart action bar
52
+Along with viewing chart type, context and units, on this bar you have access to immediate actions over the chart:
53
68
-When you start interacting with a chart, you'll notice valuable information on the top bar. You will see information
69
-from the chart title to a chart action bar.
54
+<img src="https://user-images.githubusercontent.com/70198089/236134195-ecb08f79-1355-4bce-8449-e829f4a6b1c0.png" width="200" />
55
71
-The elements that you can find on this top bar are:
56
+- **Chart info**: get more information relevant to the chart you are interacting with.
57
+- **Chart type**: change the chart type from **line**, **stacked**, **area**, **stacked bar** and **multi bar**.
58
+- **Enter fullscreen mode**: expand the current chart to the full size of your screen.
59
+- **Add chart to dashboard**: add the chart to an existing custom dashboard or directly create a new one that includes the chart.
60
73
-- Netdata icon: this indicates that data is continuously being updated, this happens
74
- if [Time controls](https://github.com/netdata/netdata/blob/master/docs/dashboard/visualization-date-and-time-controls.md#time-controls)
75
- are in Play or Force Play mode
76
-- Chart status icon: indicates the status of the chart. Possible values are: Loading, Timeout, Error or No data
77
-- Chart title: on the chart title you can see the title together with the metric being displayed, as well as the unit of
78
- measurement
79
-- Chart action bar: here you'll have access to chart info, change chart types, enables fullscreen mode, and the ability
80
- to add the chart to a custom dashboard
61
+## Definition bar
62
82
-
63
+Each composite chart has a definition bar to provide information and options about the following:
64
65
+<img src="https://user-images.githubusercontent.com/70198089/236134615-e53a1d68-8a0f-466b-b2ef-1974085f0e8d.png" width="900"/>
66
+
67
+- Group by option
68
+- Aggregate function to be applied in case multiple data sources exist
69
+- Nodes filter
70
+- Instances filter
71
+- Dimensions filter
72
+- Labels filter
73
+- The aggregate function over time to be applied if one point in the chart consists of multiple data points aggregated
74
+- Resetting the Definition bar
75
+
76
+### NIDL framework
77
+
78
+To help users instantly understand and validate the data they see on charts, we developed the NIDL (Nodes, Instances, Dimensions, Labels) framework. This information is visualized on all charts.
79
+
80
+
81
+> You can explore the in-depth infographic, by clicking on this image and opening it in a new tab,
82
+> allowing you to zoom in to the different parts of it.
83
+>
84
+> <a href="https://user-images.githubusercontent.com/2662304/235475061-44628011-3b1f-4c44-9528-34452018eb89.png" target="_blank">
85
+> <img src="https://user-images.githubusercontent.com/2662304/235475061-44628011-3b1f-4c44-9528-34452018eb89.png" width="400" border="0" align="center"/>
86
+> </a>
87
85
-## Definition bar
88
87
-Each composite chart has a definition bar to provide information about the following:
89
+You can rapidly access condensed information for collected metrics, grouped by node, monitored instances, dimension, or any key/value label pair.
90
89
-* Grouping option
90
-* Aggregate function to be applied in case multiple data sources exist
91
-* Instances
92
-* Nodes
93
-* Dimensions, and
94
-* Aggregate function over time to be applied if one point in the chart consists of multiple data points aggregated
91
+At the Definition bar of each chart, there are a few dropdown menus:
92
96
-### Group by dimension, node, or chart
93
+<img src="https://user-images.githubusercontent.com/43294513/235470150-62a3b9ac-51ca-4c0d-81de-8804e3d733eb.png" width="900"/>
94
98
-Click on the **dimension** dropdown to change how a composite chart groups metrics.
95
+These dropdown menus have 2 functions:
96
100
-The default option is by _dimension_, so that each line/area in the visualization is the aggregation of a single
101
-dimension.
102
-This provides a per dimension view of the data from all the nodes in the War Room, taking into account filtering
103
-criteria if defined.
97
+1. Provide additional information about the visualized chart, to help with understanding the data that is presented.
98
+2. Provide filtering and grouping capabilities, altering the query on the fly, to help get different views of the dataset.
99
105
-A composite chart grouped by _node_ visualizes a single metric across contributing nodes. If the composite chart has
106
-five
107
-contributing nodes, there will be five lines/areas. This is typically an absolute value of the sum of the dimensions
108
-over each node but there
109
-are some opinionated-but-valuable exceptions where a specific dimension is selected.
110
-Grouping by nodes allows you to quickly understand which nodes in your infrastructure are experiencing anomalous
111
-behavior.
100
+The NIDL framework attaches metadata to every metric that is collected to provide for each of them the following consolidated data for the visible time frame:
101
113
-A composite chart grouped by _instance_ visualizes each instance of one software or hardware on a node and displays
114
-these as a separate dimension. By grouping the
115
-`disk.io` chart by _instance_, you can visualize the activity of each disk on each node that contributes to the
116
-composite
117
-chart.
102
+1. The volume contribution of each metric into the final query. So even if a query comes from 1000 nodes, the contribution of each node in the result can instantly be visualized. The same goes for instances, dimensions and labels. Especially for labels, Netdata also provides the volume contribution of each label `key:value` pair to the final query, so that you can immediately see how much every label value involved in the query affected the chart.
103
+2. The anomaly rate of each of them for the time-frame of the query. This is used to quickly spot which of the nodes, instances, dimensions or labels have anomalies in the requested time-frame.
104
+3. The minimum, average and maximum values of all the points used for the query. This is used to quickly spot which of the nodes, instances, dimensions or labels are responsible for a spike or a dive in the chart.
105
119
-Another very pertinent example is composite charts over contexts related to cgroups (VMs and containers). You have the
120
-means to change the default group by or apply filtering to
121
-get a better view into what data your are trying to analyze. For example, if you change the group by to _instance_ you
122
-get a view with the data of all the instances (cgroups) that
123
-contribute to that chart. Then you can use further filtering tools to focus the data that is important to you and even
124
-save the result to your own dashboards.
106
+All of these dropdown menus can be used for instantly filtering the information shown, by including or excluding specific nodes, instances, dimensions or labels. Directly from the dropdown menu, without the need to edit a query string and without any additional knowledge of the underlying data.
107
126
-
108
+### Group by dropdown
109
128
-### Aggregate functions over data sources
110
+The "Group by" dropdown menu allows selecting 1 or more groupings to be applied at once on the same dataset.
111
130
-Each chart uses an opinionated-but-valuable default aggregate function over the data sources. For example,
131
-the `system.cpu` chart shows the
132
-average for each dimension from every contributing chart, while the `net.net` chart shows the sum for each dimension
133
-from every contributing chart, which can also come from multiple networking interfaces.
112
+<img src="https://user-images.githubusercontent.com/43294513/235468819-3af5a1d3-8619-48fb-a8b7-8e8b4cf6a8ff.png" width="900"/>
113
+
114
+It supports:
115
+
116
+1. **Group by Node**, to summarize the data of each node, and provide one dimension on the chart for each of the nodes involved. Filtering nodes is supported at the same time, using the nodes dropdown menu.
117
+2. **Group by Instance**, to summarize the data of each instance and provide one dimension on the chart for each of the instances involved. Filtering instances is supported at the same time, using the instances dropdown menu.
118
+3. **Group by Dimension**, so that each metric in the visualization is the aggregation of a single dimension. This provides a per dimension view of the data from all the nodes in the War Room, taking into account filtering criteria if defined.
119
+4. **Group by Label**, to summarize the data for each label value. Multiple label keys can be selected at the same time.
120
+
121
+Using this menu, you can slice and dice the data in any possible way, to quickly get different views of it, without the need to edit a query string and without any need to better understand the format of the underlying data.
122
+
123
+> ### Tip
124
+>
125
+> A very pertinent example is composite charts over contexts related to cgroups (VMs and containers).
126
+> You have the means to change the default group by or apply filtering to get a better view into what data your are trying to analyze.
127
+> For example, if you change the group by to _instance_ you get a view with the data of all the instances (cgroups) that contribute to that chart.
128
+> Then you can use further filtering tools to focus the data that is important to you and even save the result to your own dashboards.
129
+
130
+> ### Tip
131
+>
132
+> Group by instance, dimension to see the time series of every individual collected metric participating in the chart.
133
+
134
+### Aggregate functions over data sources dropdown
135
+
136
+Each chart uses an opinionated-but-valuable default aggregate function over the data sources.
137
+
138
+<img src="https://user-images.githubusercontent.com/70198089/236136725-778670b4-7e81-44a8-8d3d-f38ded823c94.png" width="500"/>
139
+
140
+For example, the `system.cpu` chart shows the average for each dimension from every contributing chart, while the `net.net` chart shows the sum for each dimension from every contributing chart, which can also come from multiple networking interfaces.
141
142
The following aggregate functions are available for each selected dimension:
143
@@ -144,105 +151,148 @@ The following aggregate functions are available for each selected dimension:
151
- **Max**: Displays a maximum value. For dimensions with positive values, the max is the value with the largest
152
magnitude. For charts with negative values, the max is the value closet to zero.
153
147
-### Dimensions
148
-
149
-Select which dimensions to display on the composite chart. You can choose **All dimensions**, a single dimension, or any
150
-number of dimensions available on that context.
154
+### Nodes dropdown
155
152
-### Instances
156
+In this dropdown, you can view or filter the nodes contributing time-series metrics to the chart.
157
+This menu also provides the contribution of each node to the volume of the chart, and a break down of the anomaly rate of the queried data per node.
158
154
-Click on **X Instances** to display a dropdown of instances and nodes contributing to that composite chart. Each line in
155
-the dropdown displays an instance name and the associated node's hostname.
156
-
157
-### Nodes
158
-
159
-Click on **X Nodes** to display a dropdown of nodes contributing to that composite chart. Each line displays a hostname
160
-to help you identify which nodes contribute to a chart. You can also use this component to filter nodes directly on the
161
-chart.
159
+<img src="https://user-images.githubusercontent.com/70198089/236137765-b57d5443-3d4b-42f4-9e3d-db1eb606626f.png" width="900"/>
160
161
If one or more nodes can't contribute to a given chart, the definition bar shows a warning symbol plus the number of
162
affected nodes, then lists them in the dropdown along with the associated error. Nodes might return errors because of
163
networking issues, a stopped `netdata` service, or because that node does not have any metrics for that context.
164
165
+### Instances dropdown
166
+
167
+In this dropdown, you can view or filter the instances contributing time-series metrics to the chart.
168
+This menu also provides the contribution of each instance to the volume of the chart, and a break down of the anomaly rate of the queried data per instance.
169
+
170
+<img src="https://user-images.githubusercontent.com/70198089/236138302-4dd4072e-3a0d-43bb-a9d8-4dde79c65e92.png" width="900"/>
171
+
172
+### Dimensions dropdown
173
+
174
+In this dropdown, you can view or filter the original dimensions contributing time-series metrics to the chart.
175
+This menu also presents the contribution of each original dimensions on the chart, and a break down of the anomaly rate of the data per dimension.
176
+
177
+<img src="https://user-images.githubusercontent.com/70198089/236138796-08dc6ac6-9a50-4913-a46d-d9bbcedd48f6.png" width="900"/>
178
+
179
+
180
+### Labels dropdown
181
+
182
+In this dropdown, you can view or filter the contributing time-series labels of the chart.
183
+This menu also presents the contribution of each label on the chart,and a break down of the anomaly rate of the data per label.
184
+
185
+<img src="https://user-images.githubusercontent.com/70198089/236139027-8a51a958-2074-4675-a41b-efff30d8f51a.png" width="900"/>
186
+
187
### Aggregate functions over time
188
189
When the granularity of the data collected is higher than the plotted points on the chart an aggregation function over
170
-time
171
-is applied. By default the aggregation applied is _average_ but the user can choose different options from the
172
-following:
173
-
174
-* Min
175
-* Max
176
-* Average
177
-* Sum
178
-* Incremental sum (Delta)
179
-* Standard deviation
180
-* Median
181
-* Single exponential smoothing
182
-* Double exponential smoothing
183
-* Coefficient variation
184
-* Trimmed Median `*`
185
-* Trimmed Mean `*`
186
-* Percentile `**`
187
-
188
-> ### Info
189
->
190
-> - `*` For **Trimmed Median and Mean** you can choose the percentage of data tha you want to focus on: 1%, 2%, 3%, 5%, 10%, 15%, 20% and 25%.
191
-> - `**` For **Percentile** you can specify the percentile you want to focus on: 25th, 50th, 75th, 80th, 90th, 95th, 97th, 98th and 99th.
190
+time is applied.
191
+
192
+<img src="https://user-images.githubusercontent.com/70198089/236411297-e123db06-0117-4e24-a5ac-955b980a8f55.png" width="400"/>
193
+
194
+By default the aggregation applied is _average_ but the user can choose different options from the following:
195
193
-For more details on each, you can refer to our Agent's HTTP API details
194
-on [Data Queries - Data Grouping](https://github.com/netdata/netdata/blob/master/web/api/queries/README.md#data-grouping).
196
+- Min, Max, Average or Sum
197
+- Percentile
198
+ - you can specify the percentile you want to focus on: 25th, 50th, 75th, 80th, 90th, 95th, 97th, 98th and 99th.
199
+ <img src="https://user-images.githubusercontent.com/70198089/236410299-de5f3367-f3b0-4beb-a73f-a49007c543d4.png" width="250"/>
200
+- Trimmed Mean or Trimmed Median
201
+ - you can choose the percentage of data tha you want to focus on: 1%, 2%, 3%, 5%, 10%, 15%, 20% and 25%.
202
+ <img src="https://user-images.githubusercontent.com/70198089/236410858-74b46af9-280a-4ab2-ad26-5a6aa9403aa8.png" width="250"/>
203
+- Median
204
+- Standard deviation
205
+- Coefficient of variation
206
+- Delta
207
+- Single or Double exponential smoothing
208
+
209
+For more details on each, you can refer to our Agent's HTTP API details on [Data Queries - Data Grouping](https://github.com/netdata/netdata/blob/master/web/api/queries/README.md#data-grouping).
210
211
### Reset to defaults
212
198
-Click on the 3-dot icon (**⋮**) on any chart, then **Reset to Defaults**, to reset the definition bar to its initial
199
-state.
213
+Finally, you can reset everything to its defaults by clicking the green "Reset" prompt at the end of the definition bar.
214
+
215
+## Anomaly Rate ribbon
216
+
217
+Netdata's unsupervised machine learning algorithm creates a unique model for each metric collected by your agents, using exclusively the metric's past data.
218
+It then uses these unique models during data collection to predict the value that should be collected and check if the collected value is within the range of acceptable values based on past patterns and behavior.
219
+
220
+If the value collected is an outlier, it is marked as anomalous.
221
+
222
+<img src="https://user-images.githubusercontent.com/70198089/236139886-79d63cf6-61ed-4aa7-842c-b5a1728c870d.png" width="900"/>
223
+
224
+This unmatched capability of real-time predictions as data is collected allows you to **detect anomalies for potentially millions of metrics across your entire infrastructure within a second of occurrence**.
225
+
226
+The Anomaly Rate ribbon on top of each chart visualizes the combined anomaly rate of all the underlying data, highlighting areas of interest that may not be easily visible to the naked eye.
227
+
228
+Hovering over the Anomaly Rate ribbon provides a histogram of the anomaly rates per presented dimension, for the specific point in time.
229
+
230
+Anomaly Rate visualization does not make Netdata slower. Anomaly rate is saved in the the Netdata database, together with metric values, and due to the smart design of Netdata, it does not even incur a disk footprint penalty.
231
201
-## Jump to single-node dashboards
232
+## Hover over the chart
233
203
-Click on **X Charts**/**X Nodes** to display one of the two dropdowns that list the charts and nodes contributing to a
204
-given composite chart. For example, the nodes dropdown.
234
+Hovering over any point in the chart will reveal a more informative overlay.
235
+It includes a bar indicating the volume percentage of each time series compared to the total, the anomaly rate, and a notification on if there are data collection issues.
236
206
-
237
+This overlay sorts all dimensions by value, makes bold the closest dimension to the mouse and presents a histogram based on the values of the dimensions.
238
208
-To jump to a single-node dashboard, click on the link icon
209
-<img class="img__inline img__inline--link" src="https://user-images.githubusercontent.com/1153921/95762109-1d219300-0c62-11eb-8daa-9ba509a8e71c.png" /> next to the
210
-node you're interested in.
239
+<img src="https://user-images.githubusercontent.com/70198089/236141460-bfa66b99-d63c-4a2c-84b1-2509ed94857f.png" width="500"/>
240
212
-The single-node dashboard opens in a new tab. From there, you can continue to troubleshoot or run
213
-[Metric Correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md) for faster root
214
-cause analysis.
241
+When hovering the anomaly ribbon, the overlay sorts all dimensions by anomaly rate, and presents a histogram of these anomaly rates.
242
216
-## Add composite charts to a dashboard
243
+#### Info column
244
218
-Click on the 3-dot icon (**⋮**) on any chart, then click on **Add to Dashboard**. Click the **+** button for any
219
-dashboard you'd like to add this composite chart to, or create a new dashboard an initiate it with your chosen chart by
220
-entering the name and clicking **New Dashboard**.
245
+Additionally, when hovering over the chart, the overlay may display an indication in the "Info" column.
246
222
-## Chart action bar
247
+Currently, this column is used to inform users of any data collection issues that might affect the chart.
248
+Below each chart, there is an information ribbon. This ribbon currently shows 3 states related to the points presented in the chart:
249
224
-On this bar you have access to immediate actions over the chart, the available actions are:
250
+1. **[P]: Partial Data**
251
+ At least one of the dimensions in the chart has partial data, meaning that not all instances available contributed data to this point. This can happen when a container is stopped, or when a node is restarted. This indicator helps to gain confidence of the dataset, in situations when unusual spikes or dives appear due to infrastructure maintenance, or due to failures to part of the infrastructure.
252
226
-- Chart info: you will be able to get more information relevant to the chart you are interacting with
227
-- Chart type: change the chart type from _line_, _stacked_ or _area_
228
-- Enter fullscreen mode: allows you expand the current chart to the full size of your screen
229
-- Add chart to dashboard: This allows you to add the chart to an existing custom dashboard or directly create a new one
230
- that includes the chart.
253
+2. **[O]: Overflown**
254
+ At least one of the datasources included in the chart was a counter that has overflown that exactly that point.
255
232
-<img src="https://user-images.githubusercontent.com/70198089/222689501-4116f5fe-e447-4359-83b5-62dadb33f4ef.png" width="40%" height="40%" />
256
+3. **[E]: Empty Data**
257
+ At least one of the dimensions included in the chart has no data at all for the given points.
258
259
+All these indicators are also visualized per dimension, in the pop-over that appears when hovering the chart.
260
235
-## Exploration action bar
261
+<img src="https://user-images.githubusercontent.com/70198089/236145768-8ffadd02-93a4-4e9e-b4ae-c1367f614a7e.png" width="700"/>
262
237
-When exploring the chart you will see a second action bar. This action bar is there to support you on this task. The
238
-available actions that you can see are:
263
+## Play, Pause and Reset
264
+
265
+Your charts are controlled using the available [Time controls](https://github.com/netdata/netdata/blob/master/docs/dashboard/visualization-date-and-time-controls.md#time-controls).
266
+Besides these, when interacting with the chart you can also activate these controls by:
267
+
268
+- Hovering over any chart to temporarily pause it - this momentarily switches time control to Pause, so that you can
269
+ hover over a specific timeframe. When moving out of the chart time control will go back to Play (if it was it's
270
+ previous state)
271
+- Clicking on the chart to lock it - this enables the Pause option on the time controls, to the current timeframe. This
272
+ is if you want to jump to a different chart to look for possible correlations.
273
+- Double clicking to release a previously locked chart - move the time control back to Play
274
+
275
+| Interaction | Keyboard/mouse | Touchpad/touchscreen | Time control |
276
+|:------------------|:---------------|:---------------------|:----------------------|
277
+| **Pause** a chart | `hover` | `n/a` | Temporarily **Pause** |
278
+| **Stop** a chart | `click` | `tap` | **Pause** |
279
+| **Reset** a chart | `double click` | `n/a` | **Play** |
280
+
281
+Note: These interactions are available when the default "Pan" action is used from the [Tool Bar](#tool-bar).
282
+
283
+## Tool bar
284
+
285
+While exploring the chart, a tool bar will appear. This tool bar is there to support you on this task.
286
+The available manipulation tools you can select are:
287
+
288
+<img src="https://user-images.githubusercontent.com/70198089/236143292-c1d75528-263d-4ddd-9db8-b8d6a31cb83e.png" width="400" />
289
290
- Pan
291
- Highlight
242
-- Horizontal and Vertical zooms
243
-- In-context zoom in and out
292
+- Select and zoom
293
+- Chart zoom
294
+- Reset zoom
295
245
-<img src="https://user-images.githubusercontent.com/70198089/222689556-58ad77bc-924f-4c3f-b38b-fc63de2f5773.png" width="40%" height="40%" />
296
297
### Pan
298
@@ -258,47 +308,45 @@ it like pushing the current timeframe off the screen to see what came before or
308
Selecting timeframes is useful when you see an interesting spike or change in a chart and want to investigate further by:
309
310
- Looking at the same period of time on other charts/sections
261
-- Running [metric correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md)
262
- to filter metrics that also show something different in the selected period, vs the previous one
263
-
264
-<img alt="image" src="https://user-images.githubusercontent.com/43294513/221365853-1142944a-ace5-484a-a108-a205d050c594.png" />
311
+- Running [metric correlations](https://github.com/netdata/netdata/blob/master/docs/cloud/insights/metric-correlations.md) to filter metrics that also show something different in the selected period, vs the previous one
312
313
| Interaction | Keyboard/mouse | Touchpad/touchscreen |
314
|:-----------------------------------|:---------------------------------------------------------|:---------------------|
315
| **Highlight** a specific timeframe | `Alt + mouse selection` or `⌘ + mouse selection` (macOS) | `n/a` |
316
270
-### Zoom
317
+### Select and zoom
318
272
-Zooming in helps you see metrics with maximum granularity, which is useful when you're trying to diagnose the root cause
273
-of an anomaly or outage. Zooming out lets you see metrics within the larger context, such as the last hour, day, or
274
-week, which is useful in understanding what "normal" looks like, or to identify long-term trends, like a slow creep in
275
-memory usage.
319
+You can zoom to a specific timeframe, either horizontally of vertically, by selecting a timeframe.
320
277
-The actions above are _normal_ vertical zoom actions. We also provide an horizontal zoom action that helps you focus on
278
-a specific Y-axis area to further investigate a spike or dive on your charts.
321
+| Interaction | Keyboard/mouse | Touchpad/touchscreen |
322
+|:-------------------------------------------|:-------------------------------------|:-----------------------------------------------------|
323
+| **Zoom** to a specific timeframe | `Shift + mouse vertical selection` | `n/a` |
324
+| **Horizontal Zoom** a specific Y-axis area | `Shift + mouse horizontal selection` | `n/a` |
325
280
-
326
+### Chart zoom
327
328
+Zooming in helps you see metrics with maximum granularity, which is useful when you're trying to diagnose the root cause
329
+of an anomaly or outage.
330
331
+Zooming out lets you see metrics within the larger context, such as the last hour, day, or week, which is useful in understanding what "normal" looks like, or to identify long-term trends, like a slow creep in memory usage.
332
333
| Interaction | Keyboard/mouse | Touchpad/touchscreen |
334
|:-------------------------------------------|:-------------------------------------|:-----------------------------------------------------|
335
| **Zoom** in or out | `Shift + mouse scrollwheel` | `two-finger pinch` <br />`Shift + two-finger scroll` |
287
-| **Zoom** to a specific timeframe | `Shift + mouse vertical selection` | `n/a` |
288
-| **Horizontal Zoom** a specific Y-axis area | `Shift + mouse horizontal selection` | `n/a` |
289
-
290
-You also have two direct action buttons on the exploration action bar for in-context `Zoom in` and `Zoom out`.
336
292
-## Other interactions
337
+## Dimensions bar
338
339
### Order dimensions legend
340
296
-The bottom legend of the chart where you can see the dimensions of the chart can now be ordered by:
341
+The bottom legend where you can see the dimensions of the chart can be ordered by:
342
+
343
+
344
+<img src="https://user-images.githubusercontent.com/70198089/236144658-6c3d0e31-9bcb-45f3-bb95-4eafdcbb0a58.png" width="300" />
345
+
346
347
- Dimension name (Ascending or Descending)
348
- Dimension value (Ascending or Descending)
300
-
301
-<img src="https://user-images.githubusercontent.com/70198089/222689791-48c77890-1093-4beb-84c2-7598353ca049.png" width="50%" height="50%" />
349
+- Dimension Anomaly Rate (Ascending or Descending)
350
351
### Show and hide dimensions
352
@@ -310,10 +358,6 @@ behaving strangely.
358
| **Show one** dimension and hide others | `click` | `tap` |
359
| **Toggle (show/hide)** one dimension | `Shift + click` | `n/a` |
360
313
-### Resize
314
-
315
-To resize the chart, click-and-drag the icon on the bottom-right corner of any chart. To restore the chart to its
316
-original height,
317
-double-click the same icon.
361
+## Resize a chart
362
319
-
363
+To resize the chart, click-and-drag the icon on the bottom-right corner of any chart. To restore the chart to its original height, double-click the same icon.