Skip to content

Commit e64753c

Browse files
jwilliams-mongojeff-allen-mongo
jwilliams-mongo
authored and
jeff-allen-mongo
committed
(DOCSP-10347): As a viewer, I can see when a chart failed to refresh (#348)
* (DOCSP-10347): As a viewer, I can see when a chart failed to refresh * (DOCSP-10347): copy review feedback
1 parent d28b1e0 commit e64753c

File tree

3 files changed

+162
-83
lines changed

3 files changed

+162
-83
lines changed

‎source/dashboards.txt

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,166 @@ add the first chart to your dashboard:
7272
:figwidth: 750px
7373
:alt: Charts New Dashboard Example
7474

75+
.. _refresh-dashboard:
76+
77+
Refresh Dashboard Data
78+
----------------------
79+
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.
82+
83+
.. _configure-auto-refresh:
84+
85+
Configure Auto Refresh Settings
86+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
87+
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.
92+
93+
To configure auto-refresh settings for a dashboard:
94+
95+
1. Select a dashboard from the :guilabel:`Dashboards` page.
96+
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.
102+
103+
#. Click :guilabel:`Save`.
104+
105+
Behavior
106+
````````
107+
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.
111+
112+
- .. include:: /includes/fact-auto-refresh-persistence.rst
113+
114+
- When |charts| loads charts on a dashboard, it does not consistently
115+
query the data source for each chart. Instead, |charts| queries the
116+
data sources when the dashboard first loads, and that data is cached
117+
on both the client and server.
118+
119+
.. note::
120+
121+
The data stored in the cache is encrypted with a key specific to
122+
your |charts| tenant.
123+
124+
- When a dashboard refreshes automatically:
125+
126+
- If a chart's data is within the staleness tolerance period,
127+
|charts-short| doesn't refresh the chart's data.
128+
129+
- If a chart's data is outside of the staleness tolerance period,
130+
|charts-short| returns the latest data from the server cache. If the
131+
server cache contains stale data, |charts-short| queries the data
132+
source for the latest data, refreshes the chart, and updates the
133+
data cached on both the client and server.
134+
135+
- When you manually refresh a dashboard, |charts-short| updates all
136+
chart data by querying the data source for the latest data even if the
137+
chart data is within the specified staleness tolerance period.
138+
139+
- When an automatic or manual refresh fails:
140+
141+
- |charts| displays the most recently rendered chart, including all of
142+
the chart's interactive elements.
143+
144+
- If |charts| has never successfully rendered the chart, the following
145+
message is displayed: ``Unable to load data``.
146+
147+
- |charts| displays the following error message at the bottom of the
148+
chart: ``Last refresh failed``.
149+
150+
- Hover over the timer next to the error message at the bottom of the
151+
chart to view more information.
152+
153+
.. figure:: /images/charts/refresh-timer.png
154+
:figwidth: 650px
155+
:alt: Timer on a chart that failed to refresh.
156+
157+
What you see depends on where you view the chart:
158+
159+
.. list-table::
160+
:widths: 33 66
161+
:stub-columns: 1
162+
:header-rows: 1
163+
164+
* - Viewing Method
165+
- Details You See
166+
167+
* - Authenticated Dashboard
168+
-
169+
- The error code that describes why the refresh failed.
170+
- Time since the last refresh occurred.
171+
- Time until the next automatic refresh occurs.
172+
173+
* - Dashboard Accessed with a Public Link
174+
-
175+
- Time since the last refresh occurred.
176+
- Time until the next automatic refresh occurs.
177+
178+
* - Embedded using an iframe or the SDK
179+
-
180+
- The :ref:`embedding error code <embedded-errors>` that
181+
describes why the refresh failed.
182+
183+
- If you're viewing the chart on an Authenticated Dashboard,
184+
click the :guilabel:`failed` link in the error message to view
185+
additional error details.
186+
187+
.. note::
188+
189+
This link is not available when you view charts on a dashboard
190+
from a public link or embedded using an iframe or the SDK.
191+
192+
- The error message includes a :guilabel:`Refresh` link if the chart
193+
is rendered on an authenticated dashboard or embedded using an
194+
iframe or the SDK. Click the link to manually refresh the chart.
195+
196+
Manually Refresh Data
197+
~~~~~~~~~~~~~~~~~~~~~
198+
199+
You can manually refresh an entire dashboard or individual charts to
200+
render your charts with the latest data. In a manual refresh, |charts|
201+
reloads data even if the current data is within your specified staleness
202+
tolerance.
203+
204+
|charts| users of all :ref:`permission levels <dashboard-permissions>`
205+
can refresh dashboard data.
206+
207+
Manually Refresh a Dashboard
208+
````````````````````````````
209+
210+
Manually refresh an entire dashboard to requery all of the data sources
211+
backing your charts and render your charts with the latest data.
212+
213+
To manually refresh dashboard data:
214+
215+
1. Select a dashboard from the :guilabel:`Dashboards` page.
216+
217+
#. Click the arrow next to the :guilabel:`Settings` button.
218+
219+
#. Click :guilabel:`Force Refresh`.
220+
221+
Manually Refresh a Single Chart
222+
```````````````````````````````
223+
224+
Manually refresh a single chart to only requery the data source for that
225+
chart and render that chart with the latest data.
226+
227+
To manually refresh a single chart:
228+
229+
1. Select a dashboard from the :guilabel:`Dashboards` page.
230+
231+
#. Click the arrow next to the :guilabel:`Settings` button.
232+
233+
#. Click :guilabel:`Force Refresh`.
234+
75235
.. _fullscreen-view:
76236

77237
Fullscreen View

‎source/images/charts/refresh-timer.png

846 KB
Loading

‎source/manage-dashboards.txt

Lines changed: 2 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -55,93 +55,12 @@ To duplicate a dashboard from the Dashboards page:
5555
user of the newly duplicated dashboard. To grant other users access,
5656
update the dashboard's :doc:`permissions </dashboard-permissions>`.
5757

58-
.. _refresh-dashboard:
59-
6058
Refresh Dashboard Data
6159
~~~~~~~~~~~~~~~~~~~~~~
6260

6361
|charts| automatically refreshes chart data once it becomes out of
64-
date with the backing data source. You can also manually refresh dashboard data at any time.
65-
66-
.. _configure-auto-refresh:
67-
68-
Configure Auto Refresh Settings
69-
```````````````````````````````
70-
71-
Charts on a dashboard automatically refresh once their data becomes out
72-
of date. You can specify how stale your charts' data can be before it is
73-
refreshed. This is known as your staleness tolerance. The default
74-
behavior is to refresh when data is one hour stale.
75-
76-
To configure auto-refresh settings for a dashboard:
77-
78-
1. Select a dashboard from the :guilabel:`Dashboards` page.
79-
80-
#. Click :guilabel:`Settings` at the top of the dashboard.
81-
82-
#. Select your data staleness tolerance from the dropdown.
83-
|charts-short| supports staleness tolerances between 1 minute and 30
84-
days.
85-
86-
#. Click :guilabel:`Save`.
87-
88-
Manually Refresh Dashboard Data
89-
```````````````````````````````
90-
91-
Manually refresh dashboard data to requery the data sources for all
92-
charts on your dashboard and render those charts with the latest data.
93-
94-
To manually refresh dashboard data:
95-
96-
1. Select a dashboard from the :guilabel:`Dashboards` page.
97-
98-
#. Click the arrow next to the :guilabel:`Settings` button.
99-
100-
#. Click :guilabel:`Force Refresh`.
101-
102-
Manually Refresh a Single Chart
103-
```````````````````````````````
104-
105-
Manually refresh a single chart to only requery the data source for that
106-
chart and render that chart with the latest data.
107-
108-
To manually refresh a single chart:
109-
110-
1. Select a dashboard from the :guilabel:`Dashboards` page.
111-
112-
#. Click the arrow next to the :guilabel:`Settings` button.
113-
114-
#. Click :guilabel:`Force Refresh`.
115-
116-
Refresh Behavior
117-
````````````````
118-
119-
- When |charts-short| refreshes dashboard data, only charts with data
120-
older than your specified staleness tolerance are refreshed.
121-
|charts-short| does not refresh the entire dashboard at once.
122-
123-
- .. include:: /includes/fact-auto-refresh-persistence.rst
124-
125-
- When |charts| loads charts on a dashboard, it does not consistently
126-
query the data source for each chart. Instead, |charts| queries the
127-
data sources when the dashboard first loads, and that data is cached
128-
on both the client and server.
129-
130-
- When a dashboard refreshes automatically:
131-
132-
- If a chart's data is within the staleness tolerance period,
133-
|charts-short| doesn't refresh the chart's data.
134-
135-
- If a chart's data is outside of the staleness tolerance period,
136-
|charts-short| returns the latest data from the server cache. If the
137-
server cache contains stale data, |charts-short| queries the data
138-
source for the latest data, refreshes the chart, and updates the
139-
data cached on both the client and server.
140-
141-
- When you manually refresh a dashboard, |charts-short| updates all
142-
chart data by querying the data source for the latest data even if the
143-
chart data is within the specified staleness tolerance period.
144-
62+
date with the backing data source. You can also manually refresh
63+
dashboard data at any time. To learn more, see :ref:`refresh-dashboard`.
14564

14665
Author Actions
14766
--------------

0 commit comments

Comments
 (0)