Skip to content

Commit 91bf50e

Browse files
committed
Update dashboard_home.md
1 parent 64c8e02 commit 91bf50e

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

ui/src/assets/markdown/dashboard_home.md

+15-11
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
1-
# Custom Dashboard Feature
1+
# Custom Dashboards as Code
22

3-
Welcome to the Custom Dashboard! This feature allows you to create and manage personalized dashboards to monitor and visualize your data effectively.
3+
Build custom dashboards to track workflow `executions`, `logs` and `metrics` filtered by specific namespaces or labels and showing data you care about.
44

5-
## Create a new Dashboard as code
5+
The declarative syntax allows you to manage dashboards as code — you can version control that dashboard definition alongside your flows.
66

7-
Below is an example of a dashboard definition that displays executions over time, a table that uses metrics to display the sum of sales per namespace, and a table that shows the log count by level per namespace:
7+
## Example
8+
9+
Below is an example dashboard definition that displays:
10+
- **time series** of **executions** over time
11+
- **table** with specific **metrics** aggregated per namespace
12+
- **table** with **logs** aggregated per log level and namespace.
813

914
```yaml
1015
title: Getting Started
@@ -84,19 +89,18 @@ charts:
8489
- prod_graph
8590
```
8691
87-
To see all available properties to configure a custom dashboard as code, see examples provided in the [Enterprise Edition Examples](https://github.com/kestra-io/enterprise-edition-examples) repository.
92+
For more examples, check our [GitHub repository](https://github.com/kestra-io/enterprise-edition-examples) and explore Dashboard Blueprints.
8893
8994
## Querying data
9095
91-
The `data` property of a chart defines the type of data that is queried and displayed. The `type` determines which columns are displayed.
96+
The `data` property of a chart defines the type of data that is queried. The `type` determines which columns are displayed.
9297

9398
Dashboards can query data from these source `types`:
9499
- `type: io.kestra.plugin.core.dashboard.data.Executions`: data related to your workflow executions
95-
- `type: io.kestra.plugin.core.dashboard.data.Logs`: logs produced by your workflows
96-
- `type: io.kestra.plugin.core.dashboard.data.Metrics`: metrics emitted by your plugins
97-
98-
After defining the data source, specify the columns to display in the chart. Each column is defined by the `field` and may include additional optional properties.
100+
- `type: io.kestra.plugin.core.dashboard.data.Logs`: logs produced by your executions
101+
- `type: io.kestra.plugin.core.dashboard.data.Metrics`: metrics emitted during executions.
99102

103+
After defining the data source, specify the **columns** to display in the chart. Each column is defined by the `field` and may include additional optional properties.
100104

101105
| Property | Description |
102106
| --- |----------------------------------------------------------------------------------------------------------------|
@@ -107,7 +111,7 @@ After defining the data source, specify the columns to display in the chart. Eac
107111
| `columnAlignment` | Specifies the alignment of the column in the table: supported alignments include `LEFT`, `RIGHT`, `CENTER` |
108112

109113

110-
You can also use the `where` property to set conditions that filter the result set before displaying it in the chart. Filters can apply to any column in the data source. For shared logic, use the `AND` operator in the `where` property to combine several conditions. If multiple conditions are needed with different logic, use the `type: OR` property.
114+
You can also use the `where` property to set conditions that filter the result set before displaying it in the chart. Filters can apply to any column in the data source. For shared logic, use the `AND` operator in the `where` property to combine several conditions. If multiple conditions are needed with a different logic, use the `type: OR` property.
111115

112116
Available filter types include:
113117
- `CONTAINS`

0 commit comments

Comments
 (0)