Documentation Index

Fetch the complete documentation index at: https://kb.vastdata.com/llms.txt

Use this file to discover all available pages before exploring further.

Dashboard Analytics

Prev Next

The Dashboard displays the following standard metrics for all pipelines:

  • Numbers of pipelines, triggers and functions

    : Total triggers, Total functions, and Total pipelines. These numbers reflect all DataEngine resources on the tenant for which you have read permission.

  • System-wide Overview: Functions Performance and Trends:

    • Total Events and Failures. This shows total events and failures in recent minutes. For example, if a deployed pipeline calls a schedule trigger that is scheduled to generate an event every five minutes, those events would appear on the graph at five minute intervals.

    • Function Invocation Duration. This shows the average duration aggregated across all running functions.

  • Top 10 pipeline graphs:

    • Active Pipelines.

    • Failing Pipelines

    • Slowest Pipelines

  • Custom Metrics. Here you can add up to 10 custom metrics reports. This enables you to create reports that visualize custom metrics, which your function code can collect, as well as metrics emitted automatically by the runtime.

Creating a Custom Metrics Report

Once a pipeline has been deployed and events have flowed, metrics emitted by the runtime are discovered. These metrics are available to you to visualize in custom metrics reports.

There are several aggregation methods to choose from, depending on which metrics you visualize in your report.

  1. On the Dashboard, click Add Custom Metrics.

  2. Configure the following settings:

    Title

    A title for the report.

    Subtitle

    An optional subtitle for the report.

    Aggregation

    Select an aggregation method from the dropdown.

    Timeframe

    Select the timeframe to show in the report.

    Pipeline

    Select a pipeline if you want to restrict the report to a specific pipeline.

    Function

    Select a function if you want to restrict the report to a specific function.

  3. Under Available Metrics, select the metrics you want to display in the report.

    • All metrics available for the selected pipelines and functions are shown.

    • The scope column distinguishes between custom metrics from function code. (scope=User) and platform automatic metrics (scope=Runtime).

    • You can select multiple metrics. All metrics that you select must be of the same type.

    • As soon as you select one metric, the type is displayed as Selected Metric Type above the Available Metrics table, for convenience.

    • Note the compatibility of aggregation methods to metrics:

      Metric Type

      Supported Aggregations

      Semantics/Temporality

      Counter

      sum, avg, min, max

      DELTA temporality: interval event counts

      Histogram

      avg, sum, min, max, p50, p95, p99

      DELTA temporality: distribution data + percentiles

      Gauge

      avg, min, max

      No temporality: point-in-time readings (no sum - can't add snapshots)

      UpDownCounter

      avg, min, max

      CUMULATIVE temporality: state values (no sum - can't add states)

  4. Under Metrics View Mode, select a view mode:

    • Individual metrics. This option shows you a graph of each metric in a separate chart in the report.

    • Individual metrics grouped by object type. This option shows you graphs of each metric for all pipelines or all functions on one chart per metric.

    • Combined comparison metrics. This option shows you graphs of all of the selected metrics superimposed on one chart.

    When you have selected a view mode, you can click the Preview button to see a preview of the report.

  5. When you are happy with your selections, click Add Metrics.

    The report you created appears on the Dashboard under Custom Metrics.

Removing a Custom Report from the Dashboard

To remove a custom report from the Dashboard, click menu__button.png and select Remove from dashboard.

Deleting a Custom Report

To delete a custom report, click menu__button.png and select Delete report.