You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/user-guide/dashboards/dashboards-in-openobserve.md
+52-15Lines changed: 52 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@ This guide introduces you to the **Dashboards** in OpenObserve, including what t
2
2
3
3
## Introduction to Dashboards
4
4
5
-
In OpenObserve, **Dashboards** are central to data visualization and monitoring. They provide a way to display real-time and historical data in an interactive, easy-to-understand format.
5
+
In OpenObserve, **Dashboards** are the central tool for data visualization and monitoring. They provide a way to display real-time and historical data in an interactive, easy-to-understand format.
6
6
7
7
The purpose of **Dashboards** is to offer an intuitive, at-a-glance view of your data, helping you:
8
8
@@ -17,40 +17,76 @@ On the left-hand side menu, click **Dashboards** to access the dashboard managem
17
17
18
18
19
19
20
+
## How to Build Dashboards
21
+
22
+
<iframewidth="560"height="315"src="https://www.youtube.com/embed/kjUvXQdL798?si=guA2AK3COvYJolIr"title="YouTube video player"frameborder="0"allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"allowfullscreen></iframe>
23
+
20
24
## Dashboard Structure in OpenObserve
21
25
22
-
**Folders**: Dashboards are stored in folders. By default, the **default** folder is created. However, you can create additional folders to organize **Dashboards** based on your requirements.
26
+
### Folders
27
+
Dashboards are stored in folders. By default, the **default** folder is created. However, you can create additional folders to organize **Dashboards** based on your requirements.
23
28
24
-
-**Creating New Folders:** To create a new folder, click the **New Folder** button, and provide a folder name and description.
29
+
!!! info "Create Folders"
30
+
To create a new folder, click the **New Folder** button, and provide a folder name and description.
25
31
26
32
27
33
28
-
-**Editing or Deleting Folders**: To edit or delete a folder, click the vertical ellipsis (three dots) menu next to the folder name in the folder list. This allows you to rename or remove the folder as needed.
34
+
!!! info "Editing or Deleting Folders"
35
+
To edit or delete a folder, click the vertical ellipsis (three dots) menu next to the folder name in the folder list. This allows you to rename or remove the folder as needed.
29
36
30
37
31
38
32
-
**Dashboards**: Inside each folder, you can create one or more **Dashboards**. Dashboards hold Panels, which represent visualizations of your data.
39
+
### Dashboards
40
+
Inside each folder, you can create one or more **Dashboards**. Dashboards hold Panels, which represent visualizations of your data.
33
41
34
-
-**Creating Dashboards**: To create a new Dashboard, click the **New Dashboard** button, add Name and Description for the Dashboard, and select an existing folder or create a new folder to organize the Dashboard. Use the **Import** button to import an existing Dashboard.
35
-
<br>**Note**: Dashboards can contain one or more Panels for visualizing various data points or metrics.
42
+
!!! info "Create Dashboards"
43
+
To create a new Dashboard, click the **New Dashboard** button, add Name and Description for the Dashboard, and select an existing folder or create a new folder to organize the Dashboard. Use the **Import** button to import an existing Dashboard.
44
+
<br>
45
+
Dashboards can contain one or more Panels for visualizing various data points or metrics.
**Panels**: A Panel contains a single visualization (e.g., a line chart, bar chart, table, etc.) representing specific data.
49
+
### Panels
50
+
A Panel displays a single visualization using one of the [supported chart types](#supported-chart-types-in-dashboards), based on specific data.
40
51
41
-
-**Adding Panels**: To add a Panel inside a Dashboard, click the **Add Panel** button.
42
-
<br>**Note**: Each Panel displays one type of visualization. You can add multiple Panels to a Dashboard to represent different data.
52
+
!!! info "Create Panels"
53
+
To add a Panel inside a Dashboard, click the **Add Panel** button. <br>
54
+
Each Panel displays one type of visualization. You can add multiple Panels to a Dashboard to represent different data.
43
55
44
56
45
57
46
58
Example of a Dashboard with Panels:
47
59
48
60
49
61
50
-
**Tabs:****Tabs** help organize your Panels into different sections within a **Dashboard**. For example, you might have one Tab for Performance, another for Errors, and another for Traffic Analysis.
51
-
52
-
-**Default Tab**: By default, Panels are added to the default Tab.
53
-
-**Creating New Tabs**: To create a new Tab, click the + icon next to the default Tab and enter a Tab name. You can create new Tabs from the **Tabs** menu under the **Dashboard Settings**.
62
+
### Supported Chart Types in Dashboards
63
+
!!! info "The following charts are supported in Dashboards:"
64
+
65
+
1. Area
66
+
2. Area stacked
67
+
3. Vertical Bar
68
+
4. Horizontal bar
69
+
5. Line
70
+
6. Scatter
71
+
7. Vertical Bar stacked
72
+
8. Horizontal bar stacked
73
+
9. Geo map
74
+
10. Maps
75
+
11. Pie
76
+
12. Donut
77
+
14. Heatmap
78
+
15. Metric Text
79
+
16. Gauge
80
+
17. HTML
81
+
18. Markdown
82
+
19. Sankey
83
+
20. Custom Charts
84
+
85
+
### Tabs
86
+
Tabs help organize your Panels into different sections within a **Dashboard**. For example, you might have one Tab for Performance, another for Errors, and another for Traffic Analysis.
87
+
By default, Panels are added to the **Default** tab.
88
+
!!! info "Create New Tabs"
89
+
To create a new Tab, click the + icon next to the default Tab and enter a Tab name. You can create new Tabs from the **Tabs** menu under the **Dashboard Settings**.
54
90
55
91
56
92
@@ -60,4 +96,5 @@ Example of a Dashboard with Panels in different Tabs:
60
96
61
97
Copy file name to clipboardExpand all lines: docs/user-guide/dashboards/index.md
+9-38Lines changed: 9 additions & 38 deletions
Original file line number
Diff line number
Diff line change
@@ -1,44 +1,15 @@
1
-
# Index
2
-
3
-
4
-
## Chart types
5
-
6
-
Following chart types are supported:
7
-
8
-
1. Area
9
-
1. Area stacked
10
-
1. Line
11
-
1. Vertical Bar
12
-
1. Horizontal bar
13
-
1. Vertical Bar stacked
14
-
1. Horizontal bar stacked
15
-
1. Heatmap
16
-
1. Geo map
17
-
1. Pie
18
-
1. Donut
19
-
1. Gauge
20
-
1. Metric text / Single stat
21
-
1. Table
22
-
23
-
<iframewidth="560"height="315"src="https://www.youtube.com/embed/kjUvXQdL798?si=guA2AK3COvYJolIr"title="YouTube video player"frameborder="0"allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"allowfullscreen></iframe>
24
-
25
-
## Dashboard variables
26
-
27
-
Dashboard variables are used to make dashboards interactive. They can be used to filter data based on certain aspects e.g. host name, kubernetes namespace, etc.
28
-
29
-
You must define dashboard variables at dashboard level and then use them on each chart within the dashboard. This allows for filtering data across multiple charts using the same variable. These variables can be used in both SQL based charts or PromQL based charts together in a single dashboard.
30
-
31
-
There are 2 kinds of variables:
32
-
33
-
1.[Static variables](variables.md)
34
-
1. Dynamic variables
35
-
36
-
Below is an example of a dashboard with a filter:
37
-
38
-
1
+
# Dashboards Overview
39
2
3
+
In OpenObserve, Dashboards are used to visualize and monitor both real-time and historical data. They present information in an interactive, easy-to-read form.
40
4
5
+
**Learn more**:
41
6
7
+
-[Dashboards in OpenObserve](dashboards-in-openobserve.md)
8
+
-[Manage Dashboards](manage-dashboards.md)
9
+
-[Variables](variables.md)
10
+
-[Variable Dependencies in Dashboards](variable-dependencies.md)
11
+
-[Comparison Against in Dashboards](comparison-against-in-dashboards.md)
Copy file name to clipboardExpand all lines: docs/user-guide/performance/download-manager.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -21,8 +21,8 @@ The Download Manager is a background service that runs on each querier node. Its
21
21
22
22
The selected querier receives a broadcast event notifying it about the new file. It then uses the Download Manager to:
23
23
24
-
1. Download the file from the object storage (e.g., S3)
25
-
2. Store it in its local disk cache
24
+
1. Download the file from the object storage, such as S3.
25
+
2. Store it in its local disk cache.
26
26
27
27
!!! Note
28
28
This process is a form of **proactive caching**. The file is downloaded and cached before any user queries it, ensuring faster response times when recent data is searched.
0 commit comments