Update info about custom dashboards (#16121)
Co-authored-by: cold_summer <73346910+ellyzabe8@users.noreply.github.com> Co-authored-by: Fotis Voutsas <fotis@netdata.cloud>
Elizabyte committed
Nov 6, 2023 at 12:06 UTC
abe49919568b29f87118c0b816a16ad91a0daf42
1 file changed
+27
-37
docs/cloud/visualize/dashboards.md
+27
-37
@@ -9,22 +9,30 @@ Click on the **Dashboards** tab in any War Room to get started.
9
10
From the Dashboards tab, click on the **+** button.
11
12
-
12
+<img width="98" alt=" Green plus button " src="https://github.com/netdata/netdata/assets/73346910/511e2b38-e751-4a88-bc7d-bcd49764b7f6"/>
13
15
-In the modal, give your new dashboard a name, and click **+ Add**.
14
17
-Click the **Add Chart** button to add your first chart card. From the dropdown, select either *All Nodes** or a specific
18
-node. If you select **All Nodes**, you will add a [composite chart](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md) to
19
-your new dashboard. Next, select the context. You'll see a preview of the chart before you finish adding it.
15
+In the modal, give your new dashboard a name, and click **+ Add**.
16
21
-The **Add Text** button creates a new card with user-defined text, which you can use to describe or document a
17
+- The **Add Chart** button on the top right of the interface adds your first chart card. From the dropdown, select either **All Nodes** or a specific
18
+node. Next, select the context. You'll see a preview of the chart before you finish adding it. In this modal you can also [interact with the chart](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md), meaning you can configure all the aspects of the [NIDL framework](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md#nidl-framework) of the chart and more in detail, you can:
19
+ - define which `group by` method to use
20
+ - select the aggregation function over the data source
21
+ - select nodes
22
+ - select instances
23
+ - select dimensions
24
+ - select labels
25
+ - select the aggregation function over time
26
+
27
+ After you are done configuring the chart, you can also change the type of the chart from the right hand side of the [Title bar](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md#title-bar), and select which of the final dimensions you want to be visible and in what order, from the [Dimensions bar](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md#dimensions-bar).
28
+
29
+- The **Add Text** button on the top right of the interface creates a new card with user-defined text, which you can use to describe or document a
30
particular dashboard's meaning and purpose.
31
24
-Be sure to click the **Save** button any time you make changes to your dashboard.
32
+> ### Important
33
+>
34
+> Be sure to click the **Save** button any time you make changes to your dashboard.
35
26
-
36
37
## Using your dashboard
38
@@ -33,24 +41,17 @@ of any number of **cards**, which can contain charts or text.
41
42
### Chart cards
43
36
-Click the **Add Chart** button to add your first chart card. From the dropdown, select either *All Nodes** or a specific
37
-node. If you select **All Nodes**, you will add a [composite chart](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/overview.md) to
38
-your new dashboard. Next, select the context. You'll see a preview of the chart before you finish adding it.
39
-
40
-The charts you add to any dashboard are fully interactive, just like the charts in an Agent dashboard or a single node's
41
-dashboard in Cloud. Zoom in and out, highlight timeframes, and more.
44
+The charts you add to any dashboard are [fully interactive](https://github.com/netdata/netdata/blob/master/docs/cloud/visualize/interact-new-charts.md), just like any other Netdata chart. You can zoom in and out, highlight timeframes, and more.
45
46
Charts also synchronize as you interact with them, even across contexts _or_ nodes.
47
48
### Text cards
49
47
-The **Add Text** button creates a new card with user-defined text. When you create a new text card or edit an existing
48
-one, select/highlight characters or words to open a modal to make them **bold**, _italic_, or <ins>underlined</ins>. You
49
-can also create a link.
50
+You can use text cards as notes to explain to other members of the [War Room](https://github.com/netdata/netdata/blob/master/docs/cloud/manage/organize-your-infrastrucutre-invite-your-team.md#netdata-cloud-war-rooms) the purpose of the dashboard's arrangement.
51
52
### Move cards
53
53
-To move any card, click and hold on the top of the card, then drag it to a new location. A red placeholder indicates the
54
+To move any card, click and hold on **Drag & rearrange** at the top right of the card and drag it to a new location. A red placeholder indicates the
55
new location. Once you release your mouse, other charts re-sort to the grid system automatically.
56
57
### Resize cards
@@ -58,27 +59,16 @@ new location. Once you release your mouse, other charts re-sort to the grid syst
59
To resize any card on a dashboard, click on the bottom-right corner and drag to the card's new size. Other cards re-sort
60
to the grid system automatically.
61
61
-## Jump to single-node dashboards
62
+## Go to chart
63
63
-Quickly jump to any node's dashboard by clicking the 3-dot icon in the corner of any card to open a menu. Hit the **Go
64
-to Chart** item.
64
+Quickly jump to the location of the chart in either the Overview tab or if the card refers to a single node, its single node dashboard by clicking the 3-dot icon in the corner of any card to open a menu. Hit the **Go to Chart** item.
65
66
You'll land directly on that chart of interest, but you can now scroll up and down to correlate your findings with other
67
-charts. Of course, you can continue to zoom, highlight, and pan through time just as you're used to with Agent
68
-dashboards.
69
-
70
-## Pin dashboards
71
-
72
-Click on the **Pin** button in any dashboard to put those charts into a separate panel at the bottom of the screen. You
73
-can now navigate through Netdata Cloud freely, individual Cloud dashboards, the Nodes tab, different War Rooms, or even
74
-different Spaces, and have those valuable metrics follow you.
75
-
76
-Pinning dashboards helps you correlate potentially related charts across your infrastructure, no matter how you
77
-organized your Spaces and War Rooms, and helps you discover root causes faster.
67
+charts. Of course, you can continue to zoom, highlight, and pan through time just as you're used to with Netdata Charts.
68
79
-## Manage your dashboards
69
+## Managing your dashboard
70
81
-To see dashboards associated with the current War Room, click **Dashboards** tab in any War Room. You can select
71
+To see dashboards associated with the current War Room, click the **Dashboards** tab in any War Room. You can select
72
dashboards and delete them using the 🗑️ icon.
73
74
### Update/save a dashboard
@@ -92,7 +82,7 @@ prompted to either overwrite the dashboard or reload to see the most recent chan
82
83
### Remove an individual card
84
95
-Click on the 3-dot icon in the corner of any card to open a menu. Click the **Remove Card** item to remove the card.
85
+Click on the 3-dot icon in the corner of any card to open a menu. Click the **Remove** item to remove the card.
86
87
### Delete a dashboard
88