Force play timezone (#11433)
* add information on play/pause and timezone selector * add missing file * rectified that timezone will only be available on Cloud * review/feedback from Jennifer Co-authored-by: jlbriston <55591909+jlbriston@users.noreply.github.com> * review/feedback from Jennifer Co-authored-by: jlbriston <55591909+jlbriston@users.noreply.github.com> * review/feedback from Jennifer Co-authored-by: jlbriston <55591909+jlbriston@users.noreply.github.com> * review/feedback from Jennifer Co-authored-by: jlbriston <55591909+jlbriston@users.noreply.github.com> * review/feedback from Jennifer Co-authored-by: jlbriston <55591909+jlbriston@users.noreply.github.com> * review after Jennifer's comments Co-authored-by: jlbriston <55591909+jlbriston@users.noreply.github.com>
Hugo Valente committed
Aug 13, 2021 at 16:28 UTC
b1c4261738acd4d2bcb86ad22b2dd3977863cc58
1 file changed
+47
-10
docs/dashboard/visualization-date-and-time-controls.mdx
renamed
+47
-10
@@ -1,13 +1,17 @@
1
---
2
-title: "Select timeframes to visualize"
3
-description: "Netdata's dashboard features a rich timeframe selector, with useful defaults and rich customization, to help you narrow your focus when troubleshooting issues or anomalies."
2
+title: "Visualization date and time controls"
3
+description: "Netdata's dashboard features powerful date visualization controls that include a time control (play, pause, force play), a timezone selector and a rich date and timeframe selector, with useful defaults and rich customization, to help you narrow your focus when troubleshooting issues or anomalies."
4
type: how-to
5
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/dashboard/select-timeframes.mdx
5
+custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/dashboard/visualization-date-and-time-controls.mdx
6
---
7
8
-# Pick timeframes to visualize
8
+# Visualization date and time controls
9
10
-While [panning through time and zooming in/out](/docs/dashboard/interact-charts.mdx) from charts is helpful when
10
+## Date and time selector
11
+
12
+### Pick timeframes to visualize
13
+
14
+While [panning through time and zooming in/out](/docs/dashboard/interact-charts.mdx) from charts it is helpful when
15
you're looking a recent history, or want to do granular troubleshooting, what if you want to see metrics from 6 hours
16
ago? Or 6 days?
17
@@ -15,7 +19,7 @@ Netdata's dashboard features a **timeframe selector** to help you visualize spec
19
By default, it shows a certain number of minutes of historical metrics based on the your browser's viewport to ensure
20
it's always showing per-second granularity.
21
18
-## Open the timeframe selector
22
+#### Open the timeframe selector
23
24
To visualize a new timeframe, you need to open the picker, which appears just above the menu, near the top-right cover
25
of the dashboard.
@@ -26,7 +30,7 @@ dashboard](https://user-images.githubusercontent.com/1153921/101507784-2c585080-
30
The **Clear** button resets the dashboard back to its default state based on your browser viewport, and **Apply** closes
31
the picker and shifts all charts to the selected timeframe.
32
29
-## Use the Quick Selector
33
+#### Use the Quick Selector
34
35
Click any of the following options in the **Quick Selector** to choose a commonly-used timeframe.
36
@@ -38,16 +42,49 @@ Click any of the following options in the **Quick Selector** to choose a commonl
42
43
Click **Apply** to see metrics from your selected timeframe.
44
41
-## Choose a specific interval
45
+#### Choose a specific interval
46
47
Beneath the Quick Selector is an input field and dropdown you use in combination to select a specific timeframe of
48
minutes, hours, days, or months. Enter a number and choose the appropriate unit of time, then click **Apply**.
49
46
-## Choose multiple days
50
+#### Choose multiple days
51
52
Use the calendar to select multiple days. Click on a date to begin the timeframe selection, then an ending date. The
53
timeframe begins at noon on the beginning and end dates. Click **Apply** to see your selected multi-day timeframe.
54
55
+## Time controls
56
+
57
+The time control provides you the following options: **Play**, **Pause** and **Force Play**.
58
+* **Play** - the content of the page will be automatically refreshed while this is in the foreground
59
+* **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
60
+chart (cursor is on top of a chart)
61
+* **Force Play** - the content of the page will be automatically refreshed even if this is in the background
62
+
63
+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
64
+ to always refresh the content of the page when the tabs are in the background.
65
+
66
+Main use cases for **Force Play**:
67
+* 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
68
+of these changes
69
+* You want to have Netdata on the background, example displayed on a TV, to constantly see metrics through dashboards or to watch the alert
70
+status
71
+
72
+
74
+
75
+## Timezone selector
76
+
77
+With the timezone selector, you have the ability to change the timezone on Netdata Cloud. More often than not teams are
78
+distributed in different timezones and they need to collaborate.
79
+
80
+Our goal is to make it easier for you and your teams to troubleshoot based on your timezone preference and communicate easily
81
+with varying timezones and timeframes without the need to be concerned about their specificity.
82
+
83
+
84
+
85
+When you change the timezone all the date and time fields will be updated to be displayed according to the specified timezone, this goes from
86
+charts to alerts information and across the Netdata Cloud.
87
+
88
## Caveats and considerations
89
90
**Longer timeframes will decrease metrics granularity**. At the default timeframe, based on your browser viewport, each
@@ -74,7 +111,7 @@ into any other Netdata dashboard.
111
There are also many ways to [customize](/docs/dashboard/customize.mdx) the standard dashboard experience, from changing
112
the theme to editing the text that accompanies every section of charts.
113
77
-### Further reading & related information
114
+## Further reading & related information
115
116
- Dashboard
117
- [How the dashboard works](/docs/dashboard/how-dashboard-works.mdx)