Skip to content

Commit 355a9de

Browse files
jeff-allen-mongojeff-allen-mongo
authored
(DOCSP-9757): Add note on cache encryption (#344)
* (DOCSP-9757): Add note on cache encryption * Move dashboard refresh to manage dashboards page
1 parent 7d4e6a8 commit 355a9de

File tree

3 files changed

+80
-75
lines changed

3 files changed

+80
-75
lines changed

‎source/dashboards.txt

Lines changed: 0 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -72,78 +72,6 @@ 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-
- 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
137-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
138-
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.
144-
145-
#. Click :guilabel:`Force Refresh`.
146-
14775
.. _fullscreen-view:
14876

14977
Fullscreen View

‎source/interact-with-charts.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _interact-with-charts:
22

3-
====================
4-
Interact with Charts
5-
====================
3+
===================================
4+
Interact with Charts on a Dashboard
5+
===================================
66

77
.. default-domain:: mongodb
88

‎source/manage-dashboards.txt

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,83 @@ 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+
60+
Refresh Dashboard Data
61+
~~~~~~~~~~~~~~~~~~~~~~
62+
63+
|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+
To manually refresh dashboard data:
92+
93+
1. Select a dashboard from the :guilabel:`Dashboards` page.
94+
95+
#. Click the arrow next to the :guilabel:`Settings` button.
96+
97+
#. Click :guilabel:`Force Refresh`.
98+
99+
Refresh Behavior
100+
````````````````
101+
102+
- When |charts-short| refreshes dashboard data, only charts with data
103+
older than your specified staleness tolerance are refreshed.
104+
|charts-short| does not refresh the entire dashboard at once.
105+
106+
- Auto-refresh settings are stored in the local browser state. These
107+
settings are not persisted with the dashboard or shared between
108+
users.
109+
110+
- When |charts| loads charts on a dashboard, it does not consistently
111+
query the data source for each chart. Instead, |charts| queries the
112+
data sources when the dashboard first loads, and that data is cached
113+
on both the client and server.
114+
115+
.. note::
116+
117+
The data stored in the cache is encrypted with a key specific to
118+
your |charts| tenant.
119+
120+
- When a dashboard refreshes automatically:
121+
122+
- If a chart's data is within the staleness tolerance period,
123+
|charts-short| doesn't refresh the chart's data.
124+
125+
- If a chart's data is outside of the staleness tolerance period,
126+
|charts-short| returns the latest data from the server cache. If the
127+
server cache contains stale data, |charts-short| queries the data
128+
source for the latest data, refreshes the chart, and updates the
129+
data cached on both the client and server.
130+
131+
- When you manually refresh a dashboard, |charts-short| updates all
132+
chart data by querying the data source for the latest data even if
133+
the chart data is within the specified staleness tolerance period.
134+
58135

59136
Author Actions
60137
--------------

0 commit comments

Comments
 (0)