Creating a dashboard

Expand all | Collapse all

To create a dashboard:

  1. Open the KUMA web interface and select the Dashboards section.
  2. Do one of the following:
    • Click the menu icon_three vertical dots icon in the upper-right corner of the window and select Create dashboard.
    • Click the Create dashboard button under the list of all dashboards.

    This opens the dashboard settings window.

  3. In that window, specify a unique name for the dashboard. The name must contain 1 to 128 Unicode characters.
  4. In the Dashboard tenant drop-down list, select the tenant that will own the new dashboard, or a certain folder in the tenant.

    If you had any set of charts from a folder in the tenant open before creating the dashboard, KUMA automatically specifies this tenant when creating the dashboard. You can change the tenant as necessary.

  5. In the Collect data from tenants drop-down list, select one or more tenants whose data you want to be represented in the dashboard.
  6. If necessary, in the Time period drop-down list, select the time period from which you want to get analytics in one of the following ways:
    • If you want to specify an exact date, in the calendar on the left, select the start and end date of the period and click Apply.

      You can select a date up to and including the current date. The date and time format depends on your browser settings. If the Date from or Date to field has a value and you have not edited the time value manually, when you select a date in the calendar, the Date from field is automatically populated with 00:00:00.000, and the Date to field with 23:59:59.999. If you have manually deleted the value in the Date from or Date to field, when you select a date in the calendar, the field is automatically populated with the current time. After you select a value in one of the fields, the focus switches to the other field. If your Date to is earlier than your Date from, this earlier value is automatically inserted into the Date from field.

    • If you want to specify a relative period, select one of the available periods in the Relative period list on the right.

      The period is calculated relative to the current time.

    • If you want to specify a custom period, edit the value of the Date from and Date to fields.

      You can enter an exact date and time in the DD.MM.YYYY HH:mm:ss.SSS format for the Russian localization and YYYY-MM-DD HH:mm:ss.SSS for the English localization or a period relative to the current time as a formula. You can also combine these methods if necessary. If you do not specify milliseconds when entering the exact date, 000 is substituted automatically. If you have edited the time in the Date from or Date to fields, picking a date in the calendar does not change the time component.

      In the relative period formulas, you can use the now parameter for the current date and time and the interval parameterization language: + (only in the Date to field), -, / (rounding to the nearest), as well as time units: y (year), M (month), w (week), d (day), h (hour), m (minute), s (second). For example, you can specify the period now-5d to get data for the last five days, or now/w to get data from the beginning of the first day of the current week (00:00:00:000 UTC) to the current time (now).

      The Date from field is required, and its value cannot exceed the value of the Date from field, and also cannot be earlier than 1970-01-01 (if specifying an exact date or a relative period). The Date to cannot be earlier than the Date from. If you do not specify a value in the Date from field, now is specified automatically.

    By default, the 1 day (now-1d) relative period is selected. The bounds of the period are inclusive: for example, for the Today time range, events are displayed from the beginning (00:00:00:000 UTC) of the current day to the current time (now) inclusive, and for the Yesterday period, events are displayed from the beginning (00:00:00:000 UTC) of the previous day to 00:00:00:000 UTC of the current day.

    KUMA stores time values in UTC, but in the user interface time is converted to the time zone of your browser. This is relevant to the relative periods: Today, Yesterday, This week, and This month. For example, if the time zone in your browser is UTC+3, and you select Today as the data display period, data will be displayed for the period from 03:00:00.000 until now, not from 00:00:00.000 until now.

    If you want to take your time zone into account when selecting a relative data display period, such as Today, Yesterday, This week, or This month, you need to manually add a time offset in the Date from and Date to fields (if a value other than now is specified) by adding or subtracting the correct number of hours. For example, if your browser's time zone is UTC+3 and you want to display data for Yesterday, you need to change Date from to now-1d/d-3h and Date to to now/d-3h. If you want to display data for the Today period, you only need to change the value in the Date from field to now/d-3h.

    If you need results up to 23:59:59:999 UTC of yesterday, you can use an SQL query with a filter by Timestamp or specify an exact date and time.

  7. If necessary, in the Refresh interval drop-down list, select the data refresh period in the dashboard widgets:
    • No refresh means data in dashboard widgets are never refreshed.
    • 1 minute
    • 5 minutes
    • 15 minutes
    • 1 hour (default)
    • 3 hours
    • 6 hours
    • 12 hours
    • 24 hours
  8. If necessary, select tags for the dashboard from the Tags drop-down list.
  9. If necessary, add a description of the dashboard.
  10. Use the CII status toggle switch to enable the display of information for assets, alerts, and incidents related to critical information infrastructure (CII). This makes such dashboards viewable only by users whose settings have the Access to CII facilities check box selected.

    If this toggle switch is disabled, widgets of the dashboard do not display information for assets, alerts, and incidents related to critical information infrastructure (CII) even if the user has access to CII facilities.

  11. Click Apply.
  12. Click the Add widget button and select a widget. This opens a window; in that window, configure the selected widget.

    You can add multiple widgets. You can drag widgets around the window by the icon icon_three dots_twice in the upper-left corner of the widget. If you need to resize the widget, you can do so using the icon that is displayed when you hover over the lower-right corner of the widget.

    The following limitations apply to widgets with the Pie chart, Bar chart, Line chart, Counter, and Date Histogram chart types:

    • In SELECT queries, you can use extended event schema fields of String, Number, and Float types.
    • In WHERE queries, you can use all types of extended event schema fields (String, Number, Float, Array of strings, Array of numbers, and Array of floats).

    For widgets with the Table chart type, in SELECT queries, you can use all types of extended event schema fields (String, Number, Float, Array of strings, Array of numbers, and Array of floats).

    By clicking the icon_three vertical dots icon in the upper-right corner of the widget, you can do the following:

    • Manage the settings of widgets
    • Create copies of widgets
    • Delete widgets
    • Download widget data in CSV format
  13. Click Create.

The new dashboard is created and displayed in the Dashboards section of the KUMA web interface.

You can also create a dashboard on the List tab in the Resources section. To do this, click the Add button and select the Dashboard resource type.

Page top