Metrics
Metrics are data exposed by tasks after execution.
A chart using Metrics could display the number of rows loaded in a bigQuery task or an output count from a SQL Query; anything exposed by an execution.
yaml
type: "io.kestra.plugin.core.dashboard.data.Metrics"Examples
Display a chart with rows inserted by Namespace.
yaml
charts:
- id: table_metrics
type: io.kestra.plugin.core.dashboard.chart.Table
chartOptions:
displayName: Rows Inserted by Namespace
data:
type: io.kestra.plugin.core.dashboard.data.Metrics
columns:
namespace:
field: NAMESPACE
inserted_rows:
field: VALUE
agg: SUM
where:
- field: NAME
type: EQUAL_TO
value: rows
orderBy:
- column: inserted_rows
order: DESC
Properties
Definitions
GREATER_THAN
type *Requiredobject
value *Requirednumberstring
field string
Possible Values
NAMESPACEFLOW_IDTASK_IDEXECUTION_IDTASK_RUN_IDTYPENAMEVALUEDATElabelKey string
GREATER_THAN_OR_EQUAL_TO
type *Requiredobject
value *Requirednumberstring
field string
Possible Values
NAMESPACEFLOW_IDTASK_IDEXECUTION_IDTASK_RUN_IDTYPENAMEVALUEDATElabelKey string
IN
type *Requiredobject
values *Requiredarray
Min items
1field string
Possible Values
NAMESPACEFLOW_IDTASK_IDEXECUTION_IDTASK_RUN_IDTYPENAMEVALUEDATElabelKey string
EQUAL_TO
type *Requiredobject
value *Requirednumberstring
field string
Possible Values
NAMESPACEFLOW_IDTASK_IDEXECUTION_IDTASK_RUN_IDTYPENAMEVALUEDATElabelKey string
IS_FALSE
type *Requiredobject
field string
Possible Values
NAMESPACEFLOW_IDTASK_IDEXECUTION_IDTASK_RUN_IDTYPENAMEVALUEDATElabelKey string
ENDS_WITH
type *Requiredobject
value *Requiredstring
field string
Possible Values
NAMESPACEFLOW_IDTASK_IDEXECUTION_IDTASK_RUN_IDTYPENAMEVALUEDATElabelKey string
io.kestra.core.models.dashboards.ColumnDescriptor
agg string
Possible Values
AVGMAXMINSUMCOUNTdisplayName string
field string
Possible Values
NAMESPACEFLOW_IDTASK_IDEXECUTION_IDTASK_RUN_IDTYPENAMEVALUEDATElabelKey string
NOT_IN
type *Requiredobject
values *Requiredarray
Min items
1field string
Possible Values
NAMESPACEFLOW_IDTASK_IDEXECUTION_IDTASK_RUN_IDTYPENAMEVALUEDATElabelKey string
STARTS_WITH
type *Requiredobject
value *Requiredstring
field string
Possible Values
NAMESPACEFLOW_IDTASK_IDEXECUTION_IDTASK_RUN_IDTYPENAMEVALUEDATElabelKey string
IS_TRUE
type *Requiredobject
field string
Possible Values
NAMESPACEFLOW_IDTASK_IDEXECUTION_IDTASK_RUN_IDTYPENAMEVALUEDATElabelKey string
REGEX
type *Requiredobject
value *Requiredstring
field string
Possible Values
NAMESPACEFLOW_IDTASK_IDEXECUTION_IDTASK_RUN_IDTYPENAMEVALUEDATElabelKey string
LESS_THAN
type *Requiredobject
value *Requirednumberstring
field string
Possible Values
NAMESPACEFLOW_IDTASK_IDEXECUTION_IDTASK_RUN_IDTYPENAMEVALUEDATElabelKey string
LESS_THAN_OR_EQUAL_TO
type *Requiredobject
value *Requirednumberstring
field string
Possible Values
NAMESPACEFLOW_IDTASK_IDEXECUTION_IDTASK_RUN_IDTYPENAMEVALUEDATElabelKey string
IS_NOT_NULL
type *Requiredobject
field string
Possible Values
NAMESPACEFLOW_IDTASK_IDEXECUTION_IDTASK_RUN_IDTYPENAMEVALUEDATElabelKey string
CONTAINS
type *Requiredobject
value *Requirednumberstring
field string
Possible Values
NAMESPACEFLOW_IDTASK_IDEXECUTION_IDTASK_RUN_IDTYPENAMEVALUEDATElabelKey string
io.kestra.core.models.dashboards.OrderBy
column *Requiredstring
Min length
1order string
Default
ASC Possible Values
ASCDESCNOT_EQUAL_TO
type *Requiredobject
value *Requirednumberstring
field string
Possible Values
NAMESPACEFLOW_IDTASK_IDEXECUTION_IDTASK_RUN_IDTYPENAMEVALUEDATElabelKey string
IS_NULL
type *Requiredobject
field string
Possible Values
NAMESPACEFLOW_IDTASK_IDEXECUTION_IDTASK_RUN_IDTYPENAMEVALUEDATElabelKey string
OR
type *Requiredobject
values *RequiredContainsEndsWithEqualToGreaterThanGreaterThanOrEqualToInIsFalseIsNotNullIsNullIsTrueLessThanLessThanOrEqualToNotEqualToNotInOrRegexStartsWith
Min items
1field string
Possible Values
NAMESPACEFLOW_IDTASK_IDEXECUTION_IDTASK_RUN_IDTYPENAMEVALUEDATE