@@ -19,11 +19,12 @@ attain insight into multiple focal points of your data in a single
1919display. Dashboards can be shared with other users.
2020
2121.. _dashboards-tab:
22+ .. _dashboards-page:
2223
23- Dashboards Tab
24- --------------
24+ Dashboards Page
25+ ---------------
2526
26- The :guilabel:`Dashboards` tab shows all dashboards you have access to
27+ The :guilabel:`Dashboards` page shows all dashboards you have access to
2728view. To learn more about dashboard permissions in |charts|, see
2829:ref:`Dashboard Permissions <dashboard-permissions>`.
2930
@@ -46,12 +47,14 @@ By default, the most recently modified dashboards are shown first in
4647the list. You can change the sort order by using the
4748:guilabel:`Sort By` dropdown menu.
4849
50+ .. _create-new-dashboard:
51+
4952Create a New Dashboard
5053----------------------
5154
5255To create a new dashboard:
5356
54- 1. From the :guilabel:`Dashboards` tab , click the
57+ 1. From the :guilabel:`Dashboards` page , click the
5558 :guilabel:`New Dashboard` button.
5659
5760#. In the :guilabel:`New Dashboard` dialog, enter a title for your
@@ -74,62 +77,72 @@ add the first chart to your dashboard:
7477Refresh Dashboard Data
7578----------------------
7679
77- You can refresh dashboard data to update all charts on the dashboard
78- with the most current data from their respective data sources. When
79- |charts| loads charts on a dashboard, it does not consistently query
80- the data source for each chart. Instead, |charts| queries the data
81- source when the dashboard first loads, and that data
82- is stored in the browser cache and used to render the charts.
83-
84- |charts| provides options to both manually refresh dashboard data and
85- configure the dashboard to automatically refresh at a specified time
86- interval. These options allow you to control how current the data
87- displayed on your dashboard is. By default, when you first create a
88- dashboard, it is configured to refresh its data every hour. The
89- :guilabel:`Auto` text next to the :icon:`sync-alt` icon signifies that
90- auto refresh is enabled.
91-
92- Manually Refresh Dashboard Data
93- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94-
95- To manually refresh dashboard data, first select a dashboard from the
96- :guilabel:`Dashboards` tab, then click the :icon:`sync-alt` button at
97- the top-right of the dashboard.
80+ |charts| automatically refreshes chart data once it becomes out of
81+ date with the backing data source. You can also manually refresh dashboard data at any time.
9882
9983.. _configure-auto-refresh:
10084
10185Configure Auto Refresh Settings
10286~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10387
104- You can configure auto refresh settings to change the interval at which
105- the dashboard data is refreshed. The dashboard shows the time its data
106- was last updated and when the next update will occur at the top-right
107- of the view .
88+ Charts on a dashboard automatically refresh once their data becomes out
89+ of date. You can specify how stale your charts' data can be before it is
90+ refreshed. This is known as your staleness tolerance. The default
91+ behavior is to refresh when data is one hour stale .
10892
109- To configure auto refresh settings for a dashboard:
93+ To configure auto- refresh settings for a dashboard:
11094
111- 1. From the dashboard view, click the arrow next to the
112- :icon:`sync-alt` button and click :guilabel:`Auto Refresh Settings`.
95+ 1. Select a dashboard from the :guilabel:`Dashboards` page.
11396
114- #. Select the desired refresh interval.
97+ #. Click :guilabel:`Settings` at the top of the dashboard.
98+
99+ #. Select your data staleness tolerance from the dropdown.
100+ |charts-short| supports staleness tolerances between 1 minute and 30
101+ days.
115102
116103#. Click :guilabel:`Save`.
117104
118- .. note::
105+ Behavior
106+ ````````
119107
120- Auto refresh settings are stored in the local browser state.
121- Settings dictating whether auto refresh is enabled and its
122- configured interval are not persisted with the dashboard or
123- shared with other users.
108+ - When |charts-short| refreshes dashboard data, only charts with data
109+ older than your specified staleness tolerance are refreshed.
110+ |charts-short| does not refresh the entire dashboard at once.
124111
125- Disable and Enable Auto Refresh
112+ - Auto-refresh settings are stored in the local browser state. These
113+ settings are not persisted with the dashboard or shared between
114+ users.
115+
116+ - When |charts| loads charts on a dashboard, it does not consistently
117+ query the data source for each chart. Instead, |charts| queries the
118+ data sources when the dashboard first loads, and that data is cached
119+ on both the client and server.
120+
121+ - When a dashboard refreshes automatically:
122+
123+ - If a chart's data is within the staleness tolerance period,
124+ |charts-short| doesn't refresh the chart's data.
125+
126+ - If a chart's data is outside of the staleness tolerance period,
127+ |charts-short| returns the latest data from the server cache. If the
128+ server cache contains stale data, |charts-short| queries the data
129+ source for the latest data, refreshes the chart, and updates the
130+ data cached on both the client and server.
131+
132+ - When you manually refresh a dashboard, |charts-short| updates all chart
133+ data by querying the data source for the latest data even if the chart
134+ data is within the specified staleness tolerance period.
135+
136+ Manually Refresh Dashboard Data
126137~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
127138
128- To disable auto refresh, click the arrow next to the :icon:`sync-alt`
129- button and click :guilabel:`Disable Auto Refresh`.
139+ To manually refresh dashboard data:
140+
141+ 1. Select a dashboard from the :guilabel:`Dashboards` page.
142+
143+ #. Click the arrow next to the :guilabel:`Settings` button.
130144
131- To enable auto refresh, click the arrow next to the :icon:`sync-alt`
132- button and click :guilabel:`Enable Auto Refresh`.
145+ #. Click :guilabel:`Force Refresh`.
133146
134147.. _fullscreen-view:
135148
@@ -142,7 +155,7 @@ show the title, description, time of last modification, and charts in
142155the entire space of the screen.
143156
144157To open a dashboard in fullscreen view, first select a dashboard from
145- the :guilabel:`Dashboards` tab , then click the expanding arrows at the
158+ the :guilabel:`Dashboards` page , then click the expanding arrows at the
146159top-right of the dashboard:
147160
148161.. figure:: /images/charts/full-screen-view.png
@@ -158,8 +171,7 @@ top-right of the dashboard:
158171 over the desired chart.
159172
160173 Additionally, in fullscreen view you can still configure
161- auto-refresh settings and manually refresh chart data using the
162- refresh button.
174+ auto-refresh settings and manually refresh chart data.
163175
164176To exit fullscreen view, either click the contracting arrows at the
165177top-right of the dashboard or press the escape key.
0 commit comments