​Custom ​Dashboards

Build custom dashboards to visualize your executions, logs and metrics.

Overview

Dashboards let you define custom queries and charts to visualize data on your executions, logs, and metrics. Rather than relying only on the default dashboard on Kestra’s home screen, you can create charts that answer specific questions and track key metrics.

The Dashboard Page

The Dashboard page displays both the default dashboard and any custom dashboards you’ve created. To switch between dashboards, use the hamburger menu. If you have over 10 dashboards, simply type the dashboard name in the search bar to quickly find it. The same menu also lets you edit or delete existing dashboards.

The + Create a new dashboard button lets you set up a new dashboard defined directly as code.

Create a new Dashboard as Code

Clicking on the + Create a new dashboard button opens a Code Editor where you can define the dashboard layout and data sources in code.

Here's an example of a dashboard definition that displays executions over time and a pie chart of execution states:

title: Getting Started
description: First custom dashboard
timeWindow:
  default: P7D
  max: P365D
charts:
  - id: executions_timeseries
    type: io.kestra.plugin.core.dashboard.chart.TimeSeries
    chartOptions:
      displayName: Executions
      description: Executions last week
      legend:
        enabled: true
      column: date
      colorByColumn: state
    data:
      type: io.kestra.plugin.core.dashboard.data.Executions
      columns:
        date:
          field: START_DATE
          displayName: Date
        state:
          field: STATE
        total:
          displayName: Executions
          agg: COUNT
          graphStyle: BARS
        duration:
          displayName: Duration
          field: DURATION
          agg: SUM
          graphStyle: LINES

  - id: executions_pie
    type: io.kestra.plugin.core.dashboard.chart.Pie
    chartOptions:
      graphStyle: DONUT
      displayName: Total Executions
      description: Total executions per state
      legend:
        enabled: true
      colorByColumn: state
    data:
      type: io.kestra.plugin.core.dashboard.data.Executions
      columns:
        state:
          field: STATE
        total:
          agg: COUNT

To see all available properties to configure a custom dashboard as code, see examples provided in the Enterprise Edition Examples repository.

Querying Data

The data property of a chart defines the type of data that will be queried and displayed. The type determines which columns are available for display.

Dashboards can query data from these source types:

• type: io.kestra.plugin.core.dashboard.data.Executions: data related to your workflow executions
• type: io.kestra.plugin.core.dashboard.data.Logs: logs produced by your workflows
• type: io.kestra.plugin.core.dashboard.data.Metrics: metrics emitted by your plugins

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.

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, with all conditions in the where property combined using the AND operator. If multiple conditions are needed with different logic, you can use the type: OR property.

Available filter types include:

• CONTAINS
• ENDS_WITH
• EQUAL_TO
• GREATER_THAN
• GREATER_THAN_OR_EQUAL_TO
• IN
• IS_FALSE
• IS_NOT_NULL
• IS_NULL
• IS_TRUE
• LESS_THAN
• LESS_THAN_OR_EQUAL_TO
• NOT_EQUAL_TO
• NOT_IN
• OR
• REGEX
• STARTS_WITH.

Available field types include the following columns:

• ATTEMPT_NUMBER
• DATE
• DURATION
• END_DATE
• EXECUTION_ID
• FLOW_ID
• FLOW_REVISION
• ID
• LABELS
• LEVEL
• MESSAGE
• NAME
• NAMESPACE
• START_DATE
• STATE
• TASK_ID
• TASK_RUN_ID
• TRIGGER_ID
• TYPE
• VALUE.

Note that some of the above are reserved only for specific types of data e.g. the LEVEL column is only available for type: io.kestra.plugin.core.dashboard.data.Logs.