The sidebars used in various sections of the Kentik Detect portal are covered in the following topics:
Several sections of the Kentik Detect portal include a sidebar at left that contains a series of panes. The controls in the panes are used to set values for queries whose results (graph and table) are shown in a display area to the right of the sidebar. The panes that are common to more than one area of the portal (Time, Filtering, and Devices) are covered in this article, while panes that are unique to a given portal section are covered as part of that section.
The following table shows which panes appear in the various portal sections that include sidebars:
|Analytics » Peering Dataset
|Analytics » Route Traffic
||• Analysis Options
|Analytics » Capacity Planning
A sidebar can be either of the following pane display modes:
- Summary mode: The panes each show only their current setting (read-only). Each pane includes an Edit button at upper right to switch the sidebar to edit mode.
- Edit mode: The panes each show their controls so that changes can be made to settings. Each pane includes a Show Summary button at upper right to switch the sidebar to summary mode.
Note: When the sidebar is in summary mode you can switch to edit mode by clicking in any pane.
In addition to individual panes, portal sidebars include the overall controls described below.
The top of the sidebar contains the Run Query button:
- If the button is blue then the button applies changes made in the sidebar to the chart and table in the display area.
- If the button is gray then all outstanding changes have already been applied.
The right side of the sidebar contains the expand/collapse control — a black vertical strip with an orange direction icon (« or ») — that appears when the cursor is hovered between the sidebar and the main display area (just to the right of the sidebar’s vertical scroll bar). The control toggles the sidebar between expanded (panes) and collapsed (icons only) states:
- When the sidebar is collapsed (default state when browser window width is less than 1100 pixels), each pane is represented by an icon. Click on the icon to pop out the pane, or click in the strip to expand the entire sidebar.
- When the sidebar is expanded (default state when browser window width is 1100 pixels or more) click anywhere in the strip to collapse.
Note: In Dashboards the sidebar is collapsed by default.
Time-range settings in the sidebar’s Time pane define the timespan covered by the query whose results are displayed in the graph and table in the display area:
- Lookback: Sets the time range for a preset duration back from the current time. The duration is chosen from the drop-down Show the menu. For example, if the current time is 11:00 and the chosen duration is Last 15 Minutes, the resulting time range will be from 10:45 to 11:00.
- From: Sets the time range to a preset duration forward from a specified start time:
- From: Date and time fields for the start of the range.
- Show the: Preset durations for the time range. For example, if the start time is 11:00 and the setting is Next 15 Minutes, the resulting time range will be from 11:00 to 11:15.
- To: Sets the time range to a preset duration back from a specified end time:
- Show the: Preset durations for specifying the start of the range. For example, if the end time is 11:00 and setting is Previous 15 Minutes, the resulting time range will be from 10:45 to 11:00.
- Before: Date and time fields for the end of the range.
- From + To: Allows a time range to be defined from a start time to an end time:
- From: Date and time fields for specifying the start of the range.
- To: Date and time fields for specifying the end of the range.
- Zone: The time zone in which times are expressed, either UTC or local.
Note: To change the default for this setting, see User Default Settings.
- Jump Back: Moves the time range back by the current duration. For example if the time range is 35 minutes from 12:10 to 12:45, the button will move the range 35 minutes earlier to 11:35 - 12:10.
- Jump Forward: Moves the time range forward by the current duration. For example if the time range is 35 minutes from 11:35 to 12:10, the button will move the range 35 minutes later to 12:10 - 12:45.
Note: When zooming the display area (see Data Explorer Chart), the Time pane is automatically set to From + To with the start and end times defined based on the zoomed region.
The use of the Filtering pane to apply filters is covered in the following topics:
The Filtering pane allows you to apply filters to the query that will be displayed in the graph and table in the display area to the right of the sidebar. Each of the dozens of filters corresponds to a dimension About Dimensions. The specified filters are included in the WHERE clause of the underlying query.
Filters are grouped into filter groups to allow control over the order of their operations.
Filters are configured, saved, and applied in the Filtering Options dialog. To open the dialog, click anywhere in the Filtering pane. The dialog contains the following panes to define the filters that will be applied to the query that will be shown in the display area:
- Saved Filters: Used to apply one or more saved filters (see Saved Filters). For more information, see Saved Filters Selector.
- Ad-Hoc Filter Groups: Used to define and apply one or more filter groups; see Ad-Hoc Filter Interface.
An unlimited number of saved or ad-hoc filter groups can be applied, each containing an unlimited number of filters.
In addition to the above panes, the dialog includes the following UI elements:
- Close button: Click the X in the upper right corner to close the dialog without saving changes to the filter settings.
- Cancel button: Close the dialog without saving changes. All elements will be restored to their values at the time the dialog was opened.
- Save Changes button: Save changes to filter settings and exit the dialog.
The Saved Filters selector in the Filtering Options dialog allows you to apply multiple saved filters to the query. Available filters include Preset filters (see About Preset Filters) and any previously saved Company filters (see About Company Filters). When multiple saved filters are selected, they are processed in the order in which they were chosen, with a conjunctive AND operator between them.
To add one or more saved filters:
- Click the Add Saved Filter button. A drop-down menu appears listing all available saved filters.
- If desired, filter the list by entering text in the field at the top.
- Click on a listed filter. A card representing the filter will appear in the list of selected filters.
- If desired, repeat the previous steps to add additional saved filters. Multiple filters will be processed in the order in which they appear, which is the order in which they are added.
Each card representing a filter has the following UI elements:
- Filter Name: The name assigned to the filter.
- Description: A description string including (ideally) what the filter does and how it is used.
- Include/Exclude Results: Choose whether traffic meeting the filter criteria is included in or excluded from query results.
- View Filters: Opens a popup showing details about the filter (see Filter Details Popup).
- Remove: Click to remove the saved filter from the list of filters applied to the current query.
Clicking on the View Filters button opens a dialog with details about the filter. The information in this dialog is read-only (not editable). The dialog contains the following UI elements:
- Filter Name: The user-specified name of the filter.
- Show/Hide Description button: A button that toggles the description between shown and hidden.
- Description: A description string including (ideally) what the filter does and how it is used.
- Filter Groups: One or more filter group tiles, each of which contains:
- Any/All indicator: Indicates whether the filters in the filter group are matched on an Any or All basis.
- Filters: A list of the individual filters in the filter group, including the dimension, operator, and value.
- AND/OR indicator: Indicates whether the filter groups in the saved filter are ANDed or ORed.
Click anywhere outside of the popup to close it.
The Ad-hoc Filter Groups pane contains an interface for the configuration of the filter groups that can be applied to a query (and also saved as a company filter). The interface includes the controls described in Filter Groups Interface, which covers the following areas:
The controls referenced above are found in the Ad-hoc Filter Groups interface in both the Filtering Options dialog (reached from the Filtering pane in portal sidebars) and the Add Saved Filter and Edit Saved Filter dialogs (see Saved Filter Admin Dialogs). However, the Filtering Options dialog contains two additional controls not found in the dialogs used for saved filters:
- Save Filters: A button at upper right that opens the Save Filter Dialog so that you can save your current filter configuration for later reuse.
Note: You can’t currently save filters with nested groups.
- Add Nested Group: A button at lower left that allows you to nest a filter group within another filter group to create more complex filters. In the screenshot below, for example, the nested group based on source city matches on any of its conditions while the overall group matches on all conditions. This enables the query to look at all traffic from Russia except traffic from either Moscow or St. Petersburg.
Once configured, a collection of filter groups can be saved for later reuse via the Saved Filters Selector. The saved filter will be available to all other users in the organization and will be classed in the Saved Filters List (Admin » Saved Filters) as a company filter (see About Company Filters).
To save a company filter, open the Save Filter dialog by clicking the Save Filters button in the Ad-Hoc Filter Groups interface. The dialog has the following fields:
- Filter name (required): A user-supplied name for the saved filter. The filter will not save if the entered value is already used as the name of a different saved filter.
- Filter description: User-supplied text that will display when the cursor hovers over the filter in the Saved Filters selection box.
After entering the Filter name and Filter description, click the Add Filter button to save the filter.
Note: To see a list of existing company filters, go to Admin » Saved Filters and click Company in the Share Level selector (see Saved Filters Page UI).
The Devices pane allows you to select the devices (routers, hosts, etc.) that will be covered by the query whose results are displayed in the graph and table in the display area. The Devices pane is covered in the following topics:
The Devices pane has the following controls:
- Device Selector (radio button): Choose one of the following:
- All: Include traffic from all of your organization’s Kentik-registered devices.
- Specific devices: Include traffic only from devices that you specify in the Selected Devices Dialog, which opens when you click in the Selected Devices Box.
- Selected Devices box: A list of currently selected devices (not shown when Device Selector is set to All).
Note: By default (e.g. when you first navigate to Data Explorer), the Selected Devices box displays one device, which is the first device (alphabetically) in your organization’s first site (alphabetically).
The Selected Devices dialog enables you to choose the devices whose traffic will be included in the query. The dialog includes the following UI elements:
- Close button: Click the X in the upper right corner to close the dialog without saving changes to the device settings.
- Device type selector: Populates the Selected Devices list with different types of devices (see Device Type Selector).
- Filter field: Filters the Device List to show only devices whose name or site contains the entered text.
- Selected Devices list: Lists all of the devices whose traffic will be included in the current query. To remove an individual device, click the X at the right of that device’s row.
- Device List: Lists all of your organization’s devices in alphabetical order of the sites to which those devices have been assigned (See About Sites).
- Use the checkbox for an individual device to add that device to the Selected Devices list.
- Use the Select All button for a given site to select all of the devices for that site.
Note: Devices that haven’t been assigned to a site are grouped under Unassigned.
- Cancel button: Close the dialog without saving changes.
- Save button: Save changes to device settings and exit the dialog.
The device type selector adds an entire category of devices to the Selected Devices list. The following categories can be added:
- All: Selects all Kentik-registered devices in your organization.
- None: Clears the selection of all devices in your organization.
- nProbe: Selects legacy host devices in your organization that represent nProbe host agents, which are now deprecated (see Host configuration).
- kprobe: Selects host devices in your organization that represent kprobe host agents, which enable Kentik Detect to derive DNS/WWW dimensions and NPM metrics (see About kprobe).
- Routers: Selects all routers, switches, and other network infrastructure devices in your organization.
To add traffic from one or more individual devices to the current query:
- In the Devices pane, click in the Selected Devices box. The Selected Devices dialog will open.
- If desired, clear the Selected Devices list by clicking the None button in the Device Type selector.
- Do one of the following to add devices to the Selected Devices list:
- To add all devices in a category, click a button on the Device Type selector.
- To add all devices from a given site, find the site in the Device List and click its Select All button.
- To add an individual device, find the device in the Device List and click its checkbox.
- Repeat the above to add each additional device.
- Click the Save button. The devices in the Selected Devices list will appear in the Selected Devices box in the Devices pane.
To remove devices from the Selected Devices box in the Devices pane, do one of the following in the Selected Devices dialog:
- Click the gray X to the right of the name of the device in the Selected Devices list.
- Uncheck the checkbox to the left of the device in the Device List.
- To remove all devices at once, click the None button in the Device Type selector.