Sysdig Documentation

New Dashboards

Notice

Support for New Dashboards is in Beta.

Sysdig Monitor allows you to create new feature-rich dashboards that support form-based and PromQL-based queries. The new Dashboards offer several user experience enhancements in addition to the support for executing PromQL queries.

  • Multiple data queries per panel

  • Basic (form-based) and advanced (PromQL) data queries

  • Compare basic query result against historical data

  • Query support:

    • Allows to query multiple metrics

    • Render the results of a query (time series) as line, bars, stacked area, stairs, and so on.

    • Ability to scope and segment each query separately

    • Inherit, augment or override dashboard scope

    • Metric descriptor based units with the ability to override

    • Assign Y-axis automatically based on query unit type with the ability to override

About the New Dashboard UI

Figure 1. New Dashboard
New Dashboard


Widgets

The New Dashboards support time series (Timechart) and Number graphs.

Timechart

A Timechart is a graph produced by applying statistical aggregation to an object over an interval. The X-axis of a timechart will always be time.

Time aggregation: For example, the average value of host.hostName metric is computed for each entity over 1 hour at 1-minute intervals.

Group aggregation: For each host.hostName the values from time aggregation are averaged over the scope and the top 10 segments are shown on the chart.

Time Navigation

The New Dashboard is based around time. After a query has been executed, Sysdig Monitor polls the infrastructure data every 10 minutes and refreshes the metrics on the Dashboard panel. You select how to view this gathered data by choosing a Preset interval and a time Range.

Presets

Presets are a way of visualizing data that Sysdig Monitor gathers every 10 minutes. Select a preset to determine the data sample to be displayed. Overview supports the following presets:

  • 10 Seconds

  • 1 Minutes

  • 10 Minutes

  • 1 Hour

  • 6 Hour

  • 1 Day

  • 2 Weeks

Presets work in conjunction with Range selections. Selecting a particular preset interval refreshes Range selection and reloads the Overview rows and events subsequently. For example:

  • 10 Minutes: Resets the Range to December 9, 2.20 pm - December 9, 2.30 pm.

  • 6 Hour: Resets the Range to December 9, 8.30 am - December 9, 2.30 pm.

  • 1 Day: Resets the Range to December 8, 2.30 pm - December 9, 2.30 pm.

Range

Range shows both date and time interval as well as the selected Presets in parenthesis. The Range indicated on the UI is determined by Presets. The time given is the closest time interval and by default, it is the current date and time preset by 1 hour.

Click on the Range tab to open a calendar to select a range.

time-window.gif

See Presets to understand how Range works with Presets.

Live

The Live badge shows if the feed (Overview rows with data) is Live or Paused.

  • Live: the data is continuously updating based on the 10-minute polling of the Sysdig back end. The Overview feed is normally always Live.

  • Paused: When a specific row is selected, the data refresh pauses and the rows will not be updated with new data coming in.

Panel Properties

Query

With the New Dashboard, you can construct queries in two ways: Form-Based and Advanced. As you construct your query and type in a keyword in the Metrics field, auto-complete offers suggestions for the metrics in the query.

Form-Based Query

Use the UI fields to construct queries. Form-based data queries consist of one or multiple metrics with time and group aggregation, Segmentation, Display, Unit for both incoming data as well as displaying data on the Y-Axis, and Scope. You can choose to inherit the Dashboard scope.

y-axis.png

Form-based queries support both Sysdig dot notation and Prometheus-compatible underscore notation.

Advanced Query

The Advanced query field supports only PromQL. Manually enter a PromQL query as follows:

new_dashboard_advQ.png

Each query starts with a group aggregator, followed by a time aggregator, then the metrics and Segmentation. For example:

sum(rate(promraw_go_memstats_heap_released_bytes_total[5m])) by(kubernetes_cluster_name)

Define Axes

Sysdig Monitor provides the flexibility to add two Y-axes on the graph. You can also determine whether you want to use them at all. Having the option to add an extra Y-axis help when you decide to add an extra query.

Specify the following for both Y-Axis and Y-Axis Right:

  • Show: Select to show the Y-Axis on the graph.

  • Scale: Specify the scale in which you want the data to be shown on the graph.

  • Unit: Specify the unit of scale for the incoming data.

  • Display Format: Specify the unit of scale for the data to be displayed on the Y-Axis.

  • Y-Max: Specify the highest value to be displayed on the Y-Axis. Consider this as the highest point on the range. You can specify the limits as numeric values. However, the type of values that you specify must match the type of values along the axis. Y-Max should be always greater than Y-Min.

  • Y-Min: Specify the lowest value to be displayed on the Y-Axis. Consider this as the lowest point on the range. You can specify both limits or you can specify one limit and let the axes automatically calculate the other.

Define Legend

Determine whether you want a legend with a descriptive label for each plotted time series. Specify the location and layout. Determine the value to be displayed should be the most recently calculated data.

For the labels, the legend uses the text you have specified in the Query Display Name and Timeseries Name fields.

promql_legend.png

Enable Show to show the legend or create a legend if one does not exist.

Right positions the legend in the upper right corner of the panel. Bottom positions the legend in the lower-left corner of the panel.

Define Panel

Specify the Panel heading and description by using the Panel tab. The description you enter appears as the panel information as follows:

panel_info.png