Dashboards, which are accessed via the Library in the Kentik portal, are covered in the following topics:
- About Dashboards
- Dashboard Layout
- Dashboard SubNav Controls
- Dashboard Title Bar
- Dashboard Query Sidebar
- Dashboard Panels
Note: For information on dashboard edit controls, settings, and properties, including adding and editing dashboards, see Dashboard Configuration.
In the Kentik portal, a dashboard is a page with one or more panels that each display a single representation (graph, table, gauge, map) of a query. The following topics provide a general overview of dashboards:
- Any query that can be displayed in Data Explorer can be saved to a panel on a dashboard.
- The contents of any dashboard may be sent as a regularly scheduled report that is emailed to a specified list of subscribers (see Report Subscriptions).
Dashboards are accessed from the Library, where both Kentik preset dashboards (Kentik Presets) and dashboards created within your organization are listed in Library Views Lists. The Library page is also where you'll find the drop-down Add menu, from which you can choose to add a new dashboard.
In its default state a dashboard simply displays the panels that have been assigned to it. To modify dashboard characteristics, such as panel layout or the number and content of individual panels, the dashboard must be in "edit" state. To enter edit state, choose Edit from the drop-down Actions menu at the top right of the dashboard. The layout and controls of a dashboard in edit state are covered in Dashboard Edit Controls.
Note: There is no edit state for dashboards that are provided by Kentik (see Kentik Presets) rather than created by your organization.
The Kentik portal supports two dashboard modes:
- Guided mode: Guided mode lets users see data about a preselected dimension without setting complex query options. When enabled, the dashboard will include a prompt (see Guided Mode UI), and the user’s response will determine the value of a predefined filter that is applied to each panel. For information on enabling Guided mode, see Guided Mode Pane.
- Standard mode: In standard mode, a dashboard has no prompt at the top of the display area. Each panel is independent unless the Device Behavior or Filter Behavior property on the panel is set to Controlled by Dashboard (see View Panel Dialog Settings), in which case the panel tracks the current device and/or filter settings of the sidebar.
Dashboard visibility determines which users can access a given dashboard:
- Private: Dashboards that you create only for your own personal use. No one else has access.
- Shared: Dashboards created by any user in your organization. All users in your organization have access. All Kentik preset dashboards are Shared.
A dashboard is made up of the following main areas:
- SubNav controls: Miscellaneous page-wide controls (see Dashboard SubNav Controls).
- Title bar: The title bar stretches across the top of the dashboard’s display area, identifying the current dashboard and containing a set of information indicators. For further information, see Dashboard Title Bar.
- Query sidebar: A popup sidebar (on right) that contains the controls used for overall Dashboard settings, as well as for settings on panels whose time range, devices, and/or filters have been specified as "Controlled by Dashboard." For further information, see Dashboard Query Sidebar.
- Display area: An area for display of individual panels. For further information, see Dashboard Panels.
Note: The layout and controls of a dashboard in edit state are covered in Dashboard Edit Controls.
The Actions menu for dashboards includes the following options:
- Edit: Puts the dashboard into edit state (see Editing a Dashboard).
- Clone Dashboard: Opens the Clone Dashboard dialog, which has the same fields and controls as the Edit Dashboard Properties dialog but without the Dashboard Dependencies pane (see Dashboard Navigation). When property settings are complete for the clone click the Add Dashboard button to create the cloned dashboard.
- Export: Prepares a visual report (PDF) including all panels of the dashboard. A notification appears when the PDF is ready to download.
- Subscribe: Opens the Subscribe dialog enabling you to create a subscription for this saved view. The form in the Subscription dialog is the same as on the Subscription tab of the Share dialog, which is covered in Subscription Tab UI.
- Unsubscribe: If you’re subscribed to this saved view, this option opens a dialog enabling you to confirm that you wish to be removed from the subscription.
- Preview as Tenant: Opens a submenu from which you can choose an MKP tenant, after which you'll be taken to the dashboard as it would appear to that tenant.
Note: Edit is not available when the dashboard is a Kentik-provided preset (see Kentik Presets).
Dashboard Title Bar
The title bar stretches across the top of the dashboard’s display area, identifying the current dashboard and containing a set of information indicators.
As shown in the table below, the indicators depend on whether the dashboard was reached from the Library or directly from another dashboard (see Dashboard Navigation).
|Element||Description||Reached via Library||Reached via Dashboard Navigation|
|Breadcrumbs||Indicates the nesting hierarchy (the path used to get to the dashboard from a source panel on another dashboard). Click the left segment to go to the source panel.||N||Y|
|Visibility icon||Indicates the visibility of the dashboard (see Dashboard Visibility):
- Shared: Multi-head icon.
- Private: Single-head icon.
|Category||The category (if any) to which the dashboard is assigned in the Library. If none, then category will be stated as “uncategorized.”||Y||N|
|Dashboard title||The name given by the user when the dashboard was created or edited (see General Dashboard Settings).||Y||Y|
Dashboard Query Sidebar
The Query sidebar contains dashboard-level controls, which are covered in the following topics:
Note: The sidebar pops up from the Query button on the SubNav. Clicking anywhere outside of the sidebar will hide it.
Dashboard Sidebar Panes
The sidebar contains a set of panes that each includes the controls used to set dashboard-wide settings. The following sections are included in the sidebar of a dashboard:
- Query buttons: The Reset and Apply buttons (see Applying Sidebar Changes).
- Guided Mode UI (guided mode dashboards only): The prompt and value selector for the guided mode filter (see Guided Mode UI).
- Time pane: Specifies the dashboard-wide time range. The time range will apply only to panels whose time range is set to Controlled by Dashboard (see Panel Time Range). For a description of the pane's controls, see Time Pane.
- Filtering pane: Specifies dashboard-wide filtering. The filters will apply only to panels whose filtering (see Panel Filtering) is set to either Additive or Controlled by Dashboard. For a description of the pane's controls, see Filtering Pane.
- Data Sources pane: Specifies the dashboard-wide data sources (e.g. devices). The data sources will apply only to panels whose data sources are set to Controlled by Dashboard (see Panel Data Sources). For a description of the pane's controls, see Data Sources Pane.
Note: Default values for the above panes can be specified in the Query tab of the Add Dashboard and Dashboard Properties dialogs (see Default Query Settings).
Applying Sidebar Changes
The Query sidebar includes two buttons located above the individual panes of the sidebar:
- Apply button: Applies changes made in the Time, Filtering, and Data Sources panes to any sidebar-controlled panels in the display area (see Dashboard Panels):
- When there are changes to apply, the button will be blue and an alert will appear over the display area.
- When there are no changes to apply the button will be grayed out.
- Reset button: Discards any changes made to the sidebar controls since changes were last applied with the Apply button.
Note: Sidebar changes are only applied to panels on which the Controlled by Dashboard setting is on in the Data Sources, Time Range, or Filtering panes on the View Panel Query Tab in the Add View Panel or Edit View Panel dialog.
Guided Mode UI
A guided-mode dashboard includes additional controls that allow a user to quickly specify the value of a filter that is applied to some or all of the dashboard's panels. These controls, located near the top of the Query tab (just below the Reset and Apply buttons), include the following UI elements:
- Prompt: The prompt specified with the Prompt Text field (see Guided Mode Settings) when the dashboard was added or edited.
- Filter value selector: Used to choose the value of the dashboard's guided-mode filter. The selector type varies depending on the dashboard's guided-mode input type:
- Freeform: A field into which the value may be entered.
- Predefined: A drop-down list from which the value must be chosen.
When the above controls are set, use the Apply button to set the current Filter value selector setting as the value of the dashboard’s predefined filter dimension (see Dimension to filter by in Guided Mode Settings). The guided-mode filter applies to all panels on the dashboard except those whose Guided Mode Behavior is set to Ignore (see View Panel Dialog Settings).
The panel display area for both guided-mode and standard-mode dashboards contains one or more panels. The display area is covered in the following topics:
- Dashboard Panel Types
- Panel UI Visibility
- Common Panel UI
- View Panel UI
- Filtering With the Key
- Raw Flow Table
- Synthetic Test Panel
- Dashboards in edit state (see Dashboard State) are covered in Dashboard Configuration.
- The UI of panels when a dashboard is in edit state is covered in Panel Edit Controls.
Dashboard Panel Types
An individual panel on a dashboard may be any of the following panel types:
- View panel: A panel that originated as a view in Data Explorer, which may be in any of the supported Chart View Types.
- Raw Flow panel: A panel that shows the unaggregated values of one or more dimensions ingested into time-stamped KDE flow records for given set of devices over a given time range (see Raw Flow Table).
- Synthetic Test panel: A panel that shows results from one or more synthetic tests (see Synthetic Test Panel).
Panel UI Visibility
As detailed in the topics below, the UI elements visible at any given moment on a dashboard panel vary depending on several factors:
- Panel type: Whether the panel is a view panel, raw flow panel, or synthetic test panel (see Dashboard Panel Types).
- Dashboard state: Whether the dashboard itself is in edit state or “view” (non-edit) state.
- Key filtering: Whether the panel is in its initial state or has been filtered (see Filtering With the Key).
- Dashboard navigation: Whether the panel enables drill down to another dashboard (see Dashboard Navigation).
Common Panel UI
The following panel UI elements are visible in both edit and non-edit state:
- Panel title: The name given to the panel by the user when the chart is created or edited. The title appears at the top of the panel. In view state it acts as a link that takes you to a view of the panel's query in the Data Explorer.
- Chart (view panels only): A visual representation (or tabular, if view type is table, matrix, or raw flow) of the traffic specified in the settings for the panel over the defined timespan on the selected devices. For details on chart types see Chart View Types.
- Key (view panels only): A set of definitions, below the chart, for the values plotted on that chart. Each series in the chart is represented in the key by a same-colored swatch. See also Filtering With the Key.
- Table: A tabular display of values (e.g. for flow dimensions or from synthetic test results) over a specified time range.
View Panel UI
The following panel UI elements appear — on view panels only (see Dashboard Panel Types) — when the dashboard is not in edit state:
- Context menu: A drop-down (upper right of panel) with the following options:
- Change Visualization: Used to select the view type (see Chart View Types).
- Export: Opens a submenu from which you can choose among various forms in which the dashboard can be exported (see Portal Export Options).
- Clear Selections (appears only when a series is selected; see Filtering With the Key): A button that resets the chart so that all series are enabled.
- Drill Down (appears only when this panel has been assigned a destination dashboard; see Dashboard Navigation): A button that enables navigation to a destination dashboard (see Navigate To Tab). The number of series currently enabled on the chart is displayed next to the button.
Filtering With the Key
In view panels only (see Dashboard Panel Types) the key accompanying each panel’s chart can be used to filter what's shown in the chart. The key works as follows (as used below, “label” means either the text identifying a given series or the associated colored swatch):
- The initial state of the chart is that all series are shown. The Drill Down button (shown if there’s a destination dashboard) will not be accompanied by a number, and the Clear Selections button will be hidden.
- Clicking on a label will "solo" the corresponding series; the plots for all other series will be disabled (not shown in the chart) and the vertical axis is re-scaled. The Drill Down button will be accompanied by the number 1, and the Clear Selections button will be shown.
- Clicking the same label again will restore the chart to its initial state.
- Clicking one or more additional labels will enable their corresponding series, adding them back to the chart. The Drill Down button will be accompanied by the number of currently enabled series, and the Clear Selections button will still be shown.
- Clicking a label for any enabled series will toggle the series back to a disabled state.
- Clicking the Clear Selections button will restore the chart to its initial state.
Note: If Cross-Panel Filtering (see View Panel Dialog Settings) is enabled on a given panel then the filtering applied with a key in that panel will affect the other panels on the dashboard and be indicated in the Filtering pane of the dashboard's sidebar.
Raw Flow Table
While view panels (see Dashboard Panel Types) may contain any of the chart types described in Chart View Types, the display area of a raw flow panel always contains a table. The table, based on settings in the Edit Raw Flow Panel dialog (see Raw Flow Dialogs), is made up of the following:
- A column for the timestamp of the flow that is represented by each row.
- A column for every dimension chosen from the Flow Fields list.
- The number of rows specified with the Row Count field.
You can click on any heading to sort the table ascending or descending based on that column.
Synthetic Test Panel
A synthetic test panel shows results from one or more synthetic tests created in the Kentik portal's Synthetics section. An individual panel may be configured to display either of the following:
- Single test: A single test defined on the Test Settings page in Synthetics, the display of which will include a health timeline (see Synthetic Test Health) and either a table (see Test Details Table), a density grid (see Density Grid), or a mesh (see Test Mesh Subtab).
- Multiple tests: Aggregated results from multiple tests of the same test type (see Synthetic Test Types).
- To learn more about synthetic tests, see Synthetics Overview.
- For details on configuring dashboard panels to display the results of synthetic tests, see Synthetic Test Dialogs.
Synthetic Test Health
A health timeline, available for single tests, is a visual representation of the currently selected time range that shows the overall status of the test for each time slice in the range (see Status Time and Scope). By default the latest time slice (far right) is selected, meaning that this is the slice for which details are given in the details table (see below). Hovering anywhere in the timeline changes the selection to the time slice at that point, causing a corresponding change to the information in the selected display type and opening a popup over the timeline that gives the start time and overall status of the selected slice.