ThousandEyes Documentation
Search…
What's New
Product Documentation
Customizing Your Dashboard
In the ThousandEyes app, you can configure your Dashboards page to meet your individual needs. If you have a role with the appropriate permissions, you can configure a dashboard and make it available for other users in your account group.
Dashboard Configuration
To view or configure new or existing dashboards, start at the top of your Dashboards page.
- 1.Use the selector to choose one of the dashboards shared within your account group, or private dashboards you've created for yourself.
- 2.Displays time since current dashboard was last refreshed.
- 3.Click the Add Widget button to edit the widgets of the current dashboard.
- 4.Click the Options button to reveal a dropdown menu with the following options:
- Create New Dashboard creates a new blank dashboard to be named and populated with widgets.
- Duplicate Dashboard creates a copy of the current dashboard.
- View Dashboard Details opens a side modal where you can configure the report title, description, and sharing options within the organization's account groups.
- Delete Dashboard deletes the currently viewed dashboard.
Settings
Select View Dashboard Details from the Options menu to configure the current dashboard's settings:
- The Dashboard Name box displays the name of the dashboard. Click in the box to edit the dashboard name. The name of a dashboard is shown when the dashboard is used on the Dashboards page.
- The Account Group Visibility setting lets you configure the following sharing options:
- All account groups: Share the current dashboard with all account groups in this organization.
- Only Current account group: Do not the share current dashboard with other account groups.
- Specific account groups: Share the current dashboard with the account groups you select from the dropdown list.
- The Set as private checkbox indicates that this dashboard will be viewable by only you. If this box is unchecked, the dashboard is available to anyone from the account group in which you created the dashboard.
- The Set as my default checkbox indicates that this dashboard will be your default dashboard--the one that appears when the Dashboards page is opened (you can still select and view other dashboards using the Current selector on the Dashboards page). Your default dashboard is displayed as "Default (Dashboard name)" in the Current selector to indicate its status as the default. If this box is unchecked, the Dashboards page displays the account group's default dashboard.
- The Set as default for account group checkbox indicates that this dashboard will be used as the default for all users in the current account group. A user default supersedes an account group default. Only users with a role that has the Set dashboard template as account group default permission can set an account group's default dashboard. You cannot set a dashboard that is shared from another account group as your default.
- Click Save Changes when you have finished editing, to return to the Dashboards page.
Widgets
Click Add Widget to open the current dashboard's widgets for configuration (settings can also be configured).
At the top of the page, the available widget types are shown in the Add New Widget panel:
Widget Configuration
You can add widgets to the dashboard by clicking and dragging the widget's icon from the Add New Widgets panel to the page below. Once you have dragged the widget into the configuration, you can configure it. To reposition a widget within the dashboard, drag it above or below another widget.
Click the Settings (gear icon) to expand or close a widget. Click the More Actions menu (three vertical dots icon) to rename, delete or duplicate the widget. Click the chevron (< or > icon, if present) to change the widget to full or half the page width.
You can exclude data from cloud agents that are experiencing local problems. To exclude these agents, click Exclude Data from Cloud Agents with Local Problems in the widget's configuration.
Once your configuration is complete, click the Return to Dashboard button. Be careful when editing a Widget's settings, since all changes are immediately applied for all users using the dashboard.
Configuration specific to each widget type follows.
Alert List
Alert List widgets display a list of active and recently cleared alerts.
Alert Type: Configure the types of alerts to show. Various combinations can be configured, from BGP Routing, Cloud and Enterprise Agents, Devices, and Endpoint Agent classes of alert types.
Limit to: Number of alerts to show. If the amount of alerts to show exceeds the configured limit, a Show more alerts link is provided.
Active within: Limit the age of alerts shown. Only alerts that are currently active, or were active during the outlined period, are shown by the widget. The currently active alerts are listed first.
Filters: Just like with report-based widgets, additional filters can be configured to narrow down displayed alerts, by specific Tests, Labels, Agents, Alert rules, etc.
Alert Grid
Alert Grid widgets display alerts from tests, broken down by Agent or BGP Monitor.
Alert Type: Agents displays the account group's agents across the top of the Alert Grid. BGP displays BGP monitors.
Filter all/any: Enter one or more filter criteria. Filter criteria will be displayed when you place focus on the text field. With "all" the filter displays matches of the criteria that meet all the criteria in the text field. With "any" the filter displays matches if any of the criteria are met. For example, two Test Name criteria of "ThousandEyes" and "Support" would match the tests "My ThousandEyes", "ThousandEyes Support site" and "Linux support website" if the selection were "any". If the selection were "all", then the only match would be "ThousandEyes Support site".
Exclude all/any: Identical to Filter all/any above, except matches cause exclusion from display in the widget.
Agent Status
Enterprise Agent Status widgets display Enterprise Agents on a world map, using the agent's IP address with the ThousandEyes geolocation database, or manually configured geographical information to place the agent in the correct location on the map.
Agents: This selector allows the widget to display either Enterprise Agents or Endpoint Agents
Show: Owned agents displays only those agents that belong to the user's current account group (i.e., agents installed using the account group's token). All Assigned Agents (Enterprise Agents only) displays owned agents, plus any agents shared to your account group from another account group in your organization.
Filter: Allows for the selection of specific agents or account groups.
Test Table
Tests widgets display a list of tests. Each test lists the name the test type, the test's alert status and a 12-hour trend graph of key metrics relevant to that test type.
Filter all/any: Enter one or more filter criteria. Filter criteria will be displayed when you place focus on the text field. With "all" the filter displays matches of the criteria that meet all the criteria in the text field. With "any" the filter displays matches if any of the criteria are met. For example, two Test Name criteria of "ThousandEyes" and "Support" would match the tests "My ThousandEyes", "ThousandEyes Support site" and "Linux support website" if the selection were "any". If the selection were "all", then the match would only be "ThousandEyes Support site".
Exclude all/any: Identical to Filter all/any above, except matches cause exclusion from display in the widget.
Data Suppression: Check a box to enable a data exclusion filter.
- Exclude Disabled tests: Omit tests that have been disabled. This is on by default.
Color Grid
The Color Grid widget shows an array of colored cards, where each card's color depends on the configured scale.
Data Source: The data source indicates which platform service will be referenced within the widget. The current options include:
- Alerts: Data is obtained from Platform Alerts
- Cloud & Enterprise Agents: Data is obtained from Scheduled Tests performed by Cloud & Enterprise Agents
- Devices: Data is obtained from Device Layer reporting
- Endpoint Agents: Data is obtained from Scheduled Tests & Monitored Domain metrics
- Routing: Data is obtained from BGP tests
Metric: Each type of ThousandEyes Data Source has its own metrics. For example, Cloud and Enterprise Agents data from agent-to-server tests have five metrics: Available Bandwidth, Capacity, Jitter, Latency, and Packet Loss. In addition to each of the ThousandEyes test types, alerts also have metrics. For more information on ThousandEyes metrics, see ThousandMetrics: what do your results mean?.
Measure: A statistical measurement. Measure types available depend on the Metric setting and will be one or more of the following:
- % positive: The percentage of measurements greater than zero. For example, the percentage of time when a Network alert was active.
- % zero: The percentage of measurements equal to zero. For example, the percentage of time when a Network alert was active.
- Maximum: The maximum value in the set of measurements, such as the latency times of a Network test over the time period of the report.
- Minimum: The minimum value in the set of measurements, such as the latency times of a Network test over the time period of the report.
- nth Percentile: The value of the Metric which contains n% of the measurements. When "nth Percentile" is selected, a text box will appear, allowing you to specify an integer for the percentile value from 1 to 99. 98% is the default. For example, a 98th Percentile whose value is 500 ms for a Metric of "Response Time" would indicate that 98% of the measurements of the response time were between 0 and 500 ms.
- Mean: The value of the arithmetic mean (i.e. average) of the measurements. For example, a Mean of 50 ms for a Metric of "Latency" for one or more Network tests would indicate that the average value of the latency in the reporting period was 50 ms.
- Median: The value of the median measurement. For example, a Median of 50 ms for a Metric of "Latency" for one or more Network tests would indicate that the value of 50 ms is the middle value in the range of all values of the latency in the reporting period.
- Total: The total number of measurements. For example, a Metric set to "Alerts" and Tests set to a HTTP Server test indicate the total number of HTTP Server alerts received in the reporting period.
- Active Time: The amount of time an Alert Rule(s) was active. (Alerts Metrics only).
- Inactive time: The amount of time an Alert Rule(s) was inactive. (Alerts Metrics only).
- Standard Deviation: The population standard deviation of a set of measurements, such as the latency times of a Network test over the time period of the report.
Cards:
- All: Data from all sources are aggregated into a single card.
- Test: Data from all tests are given their own card based on group cards configuration.
- Test Labels: Data from all test labels configured in Settings > Labels are given their own card based on group cards configuration.
- Agents: Data from all agents are given their own card based on group cards configuration.
- Agent Labels: Data from all agent labels configured in Settings > Labels are given their own card based on group cards configuration.
- Servers: Data from all Target servers are given their own card, and the card is displayed for each Target server.
- Continents: Data from all sources are aggregated by continent. A card is displayed for each continent that has data from at least one source.
- Countries: Data from all sources are aggregated by country. A card is displayed for each country that has data from at least one source.
Group Cards By:
- All: Data from all sources are grouped by Cards drop-down menu configuration.
- Test: Data from sources configured in Cards are grouped by Test name.
- Test Labels: Data from sources configured in Cards are grouped by Test Labels.
- Agents: Data from sources configured in Cards are grouped by Agent name.
- Agent Labels: Data from sources configured in Cards are grouped by Agent Labels name.
- Servers: Data from sources configured in Cards are grouped by Target Servers name.
- Continents: Data from sources configured in Cards are grouped and aggregated by Continent.
- Countries: Data from sources configured in Cards are grouped and aggregated by Country.
Sort Cards By: For cards displayed in multiple rows, the Sort By setting will determine in what order the cards appear. That is, the value of the Sort Cards By setting is applied to the value in the Cards setting:
- Alphabetical: Sort rows by ascending alphabetical order.
- Alphabetical (Reverse): Sort rows by descending alphabetical order.
- Value: Sort rows by highest value first.
- Value (Reverse): Sort rows by lowest value first.
Time Span: Select a number of minutes, hours, or days. The widget displays data for the time span configured in Time setting.
Scale: Select a number range on how cards will be colored. Select the maximum metric value for a card to be colored green and the minimum metric value for a card to be colored red.
Columns: Select a number of group of cards displayed per column, the dashboard can allocate up to two columns on the widget.
Limit To: When checked, the cards in a group will be displayed up to the number you set in the selector. When more cards exist than are displayed, the Sort Cards By order determines which cards are displayed.
Report Widgets
Report widgets display a report for the dashboard in the same manner that reports widgets are configured using the Reports feature. Every type of report widget that is available in the Reports feature can be used in a dashboard. For information on what each type of reports a widget provides and how to configure the widget, see Dashboards and Reports.
Related Information
The following resources provide further information:
- ​Dashboards and Reports guides you through configuring a report - a feature similar to dashboards, but with additional abilities such as report snapshot creation (periodic or instant) and externally embeddable widgets.
- The ThousandEyes Developer Reference for the dashboards API walks you through how to create, edit, delete, and manage your dashboard through our API. Note, however, that the v7 API is currently in preview mode, and subject to change.
Last modified 4mo ago