Working with dashboards

Dashboards use data contained in reports. Before you add a chart to a dashboard, the data for the chart must be included in a report. To create a report, see Working with reports.

View dashboards

You can view any dashboard to which you have role-based access control (RBAC) permissions.

  1. From the Main menu, go to Data > Dashboards.
    The Dashboards page opens to show all dashboards to which you have access.
    • Use the search and filter controls above the list of dashboards to show only dashboards that match the criteria you specify. Dashboards must match all filters and any search text to appear in the dashboards grid.
      • To search for a dashboard, enter a value in the Search by text field to show dashboards whose name or description contains the text.
      • You can filter the dashboards grid by favorites, content set, author, and creation date.
    • Use the Labels section to create labels and apply them to dashboards and reports. For more information, see Managing labels.
    • Click next to View as to show the dashboards in the grid as text. Click to show a preview of the charts in the dashboards. When you preview charts, click on the chart to add the chart to your favorites list, and you can change the computer group for an individual chart. If you change the computer group when you view a chart, the change is temporary. To change the computer group permanently, edit the dashboard.

      Only computer management groups appear as filter options for dashboards. For information about the types of computer groups, see Tanium Console User Guide: Managing computer groups.

      To increase the speed at which the chart previews render, use the search and filter controls above the list of dashboards to limit the number of dashboards before you click .

    • Click next to a dashboard to add the dashboard to your favorites list, or click next to a dashboard to remove the dashboard from your favorites list. You can filter the dashboards to show only your favorite dashboards.
  2. Click the dashboard that you want to view. When viewing a dashboard, the following options are available:
    • In the header of the dashboard, select a Computer Group and Timeframe to apply to all charts. Note that some charts might not contain data for all timeframes and computer groups.

      Only computer management groups appear as filter options for dashboards. For information about the types of computer groups, see Tanium Console User Guide: Managing computer groups.

    • By default, a dashboard updates every two minutes when the browser tab is open. In the header of the dashboard, click Refresh to manually refresh all charts on the dashboard. To change the automatic refresh interval, click and either select an interval or select Pause auto refresh to stop automatic refreshes.
    • You can edit the name, description, content set, and assigned labels for the dashboard. Click next to the dashboard name and then click in the upper right of the pane that appears. Edit the desired fields and click Save.
    • Click the name of a chart panel to open the report that supplies the data to the chart.

    • Click any data point on a chart to view the data in the report.
    • Click Clone to create a copy of the dashboard.
    • Click Delete to delete the dashboard.
    • Click Edit to open the dashboard in edit mode. See Edit dashboard.

Create dashboard

  1. From the Main menu, click Data > Dashboards.
  2. Click Create Dashboard.
  3. Enter a name for the dashboard, and assign a content set and any labels to the dashboard.
    • The dashboard name can have up to a maximum of 255 characters.
    • A dashboard is available only to users with permission to the content set.
    • Only content sets to which you have permission to create dashboards appear as options.
  4. (Optional) Enter a description for the dashboard and assign labels.
    • You can assign one or more labels to the dashboard for quicker access. For information on labels, see Managing labels.
  5. Click Create.

Reporting saves the dashboard and opens the dashboard in edit mode.

To quickly create similar dashboards, you can copy an existing dashboard and then edit the new dashboard. To copy a dashboard, open the dashboard, click Save AsClone. Edit any basic settings for the dashboard and click Save.

Edit dashboard

After you create a dashboard, you can edit the dashboard to add, remove, and reorder sections and panels.

For Tanium Managed dashboards, you can edit the content set and assign additional labels to the labels provided by Tanium. No other fields are editable. You can copy any dashboard, including dashboards managed by Tanium, and then edit the new dashboard.

  1. To edit a dashboard, open the dashboard from the Dashboards page and click Edit.
  2. Edit the dashboard as needed.
    • The dashboard editor contains a grid layout to assist when you resize and move panels within the grid.
    • To edit the name, description, content set, or assigned labels for the report, click Edit next to the report name.
    • To add a section, see Add sections.
    • To add a panel, see Working with dashboards.
    • To add a chart panel, see Add chart panels.
    • To add a text panel, see Add text panels.
    • To move a section, select Reorder Sections, and then click and drag sections in the desired order.
    • To move a panel, click the white space in the panel, and then drag the panel to the desired location. When you release the mouse button, the panel snaps to the nearest coordinates on the design grid.




      If you resize or move panels in a section, the section might automatically resize vertically to match the largest height of panels.
    • To resize a panel, click and drag any panel corner or panel edge midpoint. When you release the mouse button, the panel snaps to the nearest coordinates on the design grid. The data that appears in the panel depends on the allocated size; to show more data, enlarge the panel.
    • When you delete a section, any panels in the section are also deleted.
    • When you delete a dashboard, any panels and sections in the dashboard are also deleted.
  3. Click Save when you finish editing the dashboard.

Any changes that you make to the dashboard are not saved until you click Save.

Add sections

A section is a collapsible division on a dashboard that you can use to group panels. A dashboard can have multiple sections, and each section can contain multiple panels. A dashboard requires at least one section; if you add a panel to a dashboard without a section, the dashboard creates a section for the panel.

  1. Open the dashboard from the Dashboards page and click Edit.
  2. Select Add > Add Section.

    Reporting adds the section to the bottom of the dashboard.

  3. Scroll to the bottom of the dashboard to find the new section.
  4. (Optional) Enter a name for the section. Section names have a maximum of 255 characters.

Add chart panels

A chart panel contains a chart that shows metrics from a report. The report that you want to use for the panel must exist before you create the panel. For more information, see Working with reports.

For example chart panels, see Reference: Chart options in Reporting.

  1. Open the dashboard from the Dashboards page and click Edit.
  2. You have the following options:

    • Select Add > Add Chart Panel to add a chart panel to the bottom section on the dashboard.



    • In a section, click Add Panel > Add Chart Panel to add a panel to that section.
  3. Use the Add Panel dialog to specify the following settings:
    1. Choose a report. Settings include:
    2. Select ReportSelect the report from which to retrieve information. This field contains reports to which you have access.
      Group By Column(Optional) Select one or more report columns by which to group data on the chart. This field populates from the columns in the report. If you do not select an option, results are shown as a single aggregate.
      Aggregate

      Aggregation summarizes the data in each group. This field appears for number charts and charts with numeric columns. You can select:

      • Count - Display the number of items in the group.
      • Percentage - (Number charts only) Display the data as a percentage of the selected group divided by the total of all groups in the source column. For example, consider a column that contains 100 rows: 75 rows contain True, 20 rows contain False, and 5 rows contain N/A. If you choose to aggregate by percentage and then select False for the Group, the percentage that appears is 20% (( 20 / (75+20+5)) * 100).

      If the report contains numeric columns, you can aggregate the data in each group based on a numeric column. The following options are available for each numeric column:

      • <column name> Average - Display the total value of all items in the group (the Sum) divided by the number of items in the group.
      • <column name> Max - Display the maximum item value in the group.
      • <column name> Min - Display the minimum item value in the group.
      • <column name> Sum - Display the total value of all items in the group.

      If a chart does not contain the Aggregate field, the results are automatically aggregated by Count.

    3. Select a chart type. When you select a type, the chart renders in the Preview pane to show the chart at different sizes. You can resize the chart after you add the chart to the dashboard. For information about chart types, see Reference: Chart options in Reporting.
    4. Customize the panel settings. The available settings depend on the report and the chart type.
    5. Panel settings
      Group(Number charts only) Select the group value to display for the chart.
      DateSelect a date for one day charts or a date range for historical charts. For options, see Reference: Chart options in Reporting.

      Reporting begins collecting data for charts when you save the dashboard. This means that for a historical chart such as an area or line chart, the chart shows a Collecting initial data message until the data exists. The chart preview shows any available data so you can see how the chart appears. Reporting collects data for the selected Aggregate combined with the Group By Column value. If a chart does not contain the Aggregate field, the results are automatically aggregated by Count. You can change the Date value in the future without losing data, but if you update the Aggregate or the Group By Column value, the chart restarts the collection process. For more information, see Data collection for historical charts.

      Subtitle(Number charts only) Enter text to display under the value in the number chart.
      Timeframe Label(Number charts only) Enter text to display under the chart.
      Computer GroupSelect the default computer group for which to show data in the panel. To show data from all endpoints, select All Computers. The computer groups include computer management groups to which you have access.

      Only computer management groups appear as options. For information about the types of computer groups, see Tanium Console User Guide: Managing computer groups.

      Max ResultsThe maximum number of items to display in the chart.
      Scale

      For vertical bar charts, area charts, and line charts, select how to scale values on the y-axis. Options include:

      • Linear - Use consistent values on the y-axis. For example, if the minimum data point on a chart is 1, and the maximum data point is 100, the y-axis values would be 0, 20, 40, 60, 80, and 100.
      • Logarithmic - Scale the y-axis on an exponential basis. Use this option for charts that contain a large range of data points.
      SortSelect how to order the items in the chart.
      • You can order items in the chart by the name of the item, or by result (value of the item).
      • You can also toggle the sort order. Set to to sort the items in the chart in ascending order (low to high), or set to to sort the items in the chart in descending order (high to low).
      X-Axis LabelEnter a label to display horizontally under the chart. This option only displays for chart types that use axis labels.
      Y-Axis LabelEnter a label to display vertically to the left of the chart. This option only displays for chart types that use axis labels.
      Trend Indicator(Number charts only) Select to hide or show a trend indicator on the chart. When you select Show, select the direction of the indicator, and the value to compare with the current value. If the value that you want to compare against does not exist, the trend indicator does not appear on the panel.
      NameEnter a name to appear at the top of the panel. The name can have up to a maximum of 255 characters.
      DescriptionEnter a description to appear at the top of the panel, underneath the name.
      Legend Display OptionsUse this section to customize the items that appear in the chart.

      • To exclude an item from the chart, deselect the checkbox next to the item.
      • Click the color next to any item to change the color that displays for that item. Colors can be reused by multiple items.
      Conditional Formatting

      Expand Conditional Formatting and click + Add to add a label to the chart when a threshold condition is met. In addition, you can apply the conditional color to the background of the chart; this setting overwrites the default background color.

      • When you add conditional formatting, viewers can easily identify panels that need attention.
      • You can add multiple conditions to a chart. Conditions are evaluated in descending order; the first condition that triggers a match is applied to the chart.
      • If you specify items to exclude in the Legend Display Options field, the excluded items are still evaluated and can trigger conditional formatting.

      For number charts, if the previous period of data is 0, the Trend Indicator shows 100% if the current data is positive, and -100% if the current data is negative. Both of these conditions trigger conditional formatting.

  4. In the Preview pane, verify the chart and text appears as you expect.

    Click Show Underlying Report Data to view the report data for the chart in the same pane.

  5. Click Done.

Add text panels

A text panel contains static text that provides context to the report. The report that you want to use for the panel must exist before you create the panel. For more information, see Working with reports.

ClosedExample text panels

  1. Open the dashboard from the Dashboards page and click Edit.
  2. You have the following options:

    • Select Add > Add Text Panel to add a chart panel to the bottom section on the dashboard.



    • In a section, click Add Panel > Add Text Panel to add a panel to that section.
  3. Use the Edit Text dialog to compose the text in the panel:
    • Use the dropdown menu to select the syntax of selected text, or to enter new text with that syntax.
    • To add a link, click Add Link . Enter the text to display and then enter a link; overwrite the default # as needed. The link can be absolute or relative. Click Save when done. The icon that renders with the link signifies if the link is external or links to another page in the Tanium Console.




      For security, a confirmation prompt appears when a user clicks an external link in the Tanium Console. If the link goes to another page in the Tanium Console, the link renders as static text if the user does not have access to the linked page.

    • To add metrics to the panel, click Add Metric . Enter a name and value for the metric, and then specify any other optional fields. Click Apply to add the metric to the text panel and to close the Edit Metric dialog. Click Add to add the metric to the text panel but keep the Edit Metric dialog open so you can add another metric.




      To include multiple metrics in a horizontal row, select the Metric Set option from the dropdown menu on the Edit Panel dialog. A shaded row appears in the dialog. Click the row, and then click Add Metric . When you add metrics, click Add to add another metric to the row.

  4. Click Done.

Save dashboard

Click Save when you finish editing the dashboard. Any changes that you make to the dashboard are not saved until you click Save.

To exit without saving changes, click Cancel.

Click Favorite next to any dashboard or chart panel name to add it to your favorites list. You can quickly access favorite dashboards and chart panels from the Tanium Home page and through the main menu at Data > Dashboards.

Export dashboard

You can download a dashboard to a standalone HTML file that you can distribute to stakeholders or post to an internal web server. Files download to your local file system through the browser.

Exported dashboards contain data for the default computer group of the dashboard.

  1. From the Main menu, click Data > Dashboards.
  2. Click the dashboard that you want to publish.
  3. Click Export and then select HTML.

Reporting renders the dashboard into a file that downloads to the local file system.

Export dashboards through Tanium Connect

Use Connect to send dashboards to Connect destinations.

Before you begin

  • You must have access to Connect with the Connect Operator role.
  • You must have access to Connect with the Connect Operator or Connect Administrator role.
  • You must have a role with the Dashboard read and Report API user permissions. Predefined roles with required permissions include Reporting Operator and Reporting User.
  • You must have Connect 5.9.65 or later and Reporting 1.12 or later.
  • You must first create a dashboard in Reporting.

Create a connection

  1. From the Main menu, go to Modules > Connect.
  2. From the Connect Overview page, scroll to the Connections section and click Create Connection.
  3. In the General Information section, provide a name and description for the connection.
  4. In the Configuration section, select Tanium Reporting (Reports and Dashboards) for the Source.
  5. Select an Export Format, select Dashboard for Type, and then select the dashboard to export.
  6. For the destination, select where you want Connect to send the dashboard. Provide any additional configuration for the type of destination you select.
  7. (Optional) In the Schedule section, set up a schedule to send the dashboard.
  8. Click Save.

When the connection runs, the dashboard is sent to the destination according to the schedule that you set. To manually export the dashboard using the connection settings, select the connection on the Connect Overview page and click Run Now.

For more information about connections, see Tanium Connect User Guide: Managing connections.

Add dashboards to the Tanium Home page

The Tanium Home page includes a Dashboard section that shows a complete dashboard, and a Dashboard List section that shows small (micro) charts for up to five dashboards. By default, the Dashboard and Dashboard List sections contain dashboards provided by Tanium. Each user can customize which dashboards appear on their Tanium Home page.

By default, the Dashboard section is hidden. To make the section visible, click Customize Page and select the sections that you want to appear on the Tanium Home page. For more information, see Tanium Console User Guide: Customize solution overview pages.

The Dashboard and Dashboard List sections only appear if Reporting 1.8 or later and Interact 2.12 or later are installed in your environment.

Add a dashboard to the Dashboard section

  1. From the Main menu, click Home.
  2. Scroll to the Dashboard section, and click Edit in the upper right corner of the section.
  3. Select a dashboard from the dropdown list. To quickly find a dashboard, enter the dashboard name in the Search field.



The dashboard that you select renders in the Dashboard section. Use the controls above the dashboard to filter the data by computer group, favorites, or to show only charts with alerts.

Add dashboards to the Dashboard List section

  1. From the Main menu, click Home.
  2. Scroll to the Dashboard List section, and click Edit in the upper right corner of the section.
  3. Select up to five dashboards from the dropdown list. To quickly find a dashboard, enter the dashboard name in the Search field.

The dashboards that you select renders in the Dashboard List section. Use the controls above the dashboard to filter the data by computer group, dashboard and chart names, favorites, or to show only charts with alerts.

For information on how to customize the Tanium Home page, see Tanium Console User Guide: Tanium Home page.

Manage historical data

Reporting collects data for historical charts when you add a chart to a dashboard and then save the dashboard. Reporting collects chart data once per day, but you can run the collection process manually at any time for one or more sources. In this context, a source is the combination of a report and its Group By selection for any charts that use the data. Perform the following steps to view the collection status for sources or to manually run the collection process.

You must be assigned a role with Reporting Historical Sources read permission to view historical data and write permission to run the collection process. For more details about historical data, see Data collection for historical charts.
  1. From the Main menu, go to Data > Settings > Historical Data Sources.

    The grid lists sources with the following information:

    ColumnDescription
    SourceThe name of the source, which is derived from the name of the report combined with the Group By selection for any charts that use the data.
    Status

    The status of the last collection run for the source.

    • Finished: The last collection run completed successfully.
    • Pending: A collection run is in-progress.
    • Failed: The last collection run did not complete successfully.
    Last RunThe date and time when the last run started.
    Total DataThe amount of data in the last collection run.

    You can sort Sort the grid by the Status or Last Run of a collection process.

  2. (Optional) Enter a text string in the Filter by source field to show only sources with names that match the string.
  3. To collect data for any sources immediately, select the check boxes next to the sources and click Run Collection.
  4. Click the name of a source to view its details.
    The Source Details page contains the following information:
    Source Details section
    FieldDescription
    Status

    The status of the last collection run for the source.

    • Finished: The last collection run completed successfully.
    • Pending: A collection run is in-progress.
    • Failed: The last collection run did not complete successfully.
    • There might be multiple runs with the Pending state for a source. Runs that time out or are overridden by another run might show the Pending state.

    ReportThe name of the report that contains the data.
    Group By ColumnsThe columns on which the data is grouped. If there are no columns listed, the data is grouped as a single aggregate.
    Total DataThe amount of data in the last collection run.


    Schedule Details section
    FieldDescription
    Collection Schedule

    How often collection runs are scheduled for the source.

    Last RunThe date and time when the last run started.
    Last UpdatedThe data and time when the data for the collection was most recently updated. On successful runs, this field is the same as the Last Run field.
    Next CollectionThe date and time when Reporting will collect data for the source.


    The Collection History section lists previous and current collection runs.

    You can sort Sort the grid by the Status or Last Run of a collection process.

    Collection History section
    ColumnDescription
    Status

    The status of the collection run.

    • Finished: The collection run completed successfully.
    • Pending: A run is in-progress.
    • Failed: The last collection run did not complete successfully.
    Report RowsThe total number of rows that the source collected.
    Grouped RowsThe number of rows collected that match the Grouped By Columns value.
    Computer GroupsThe number of computer groups included in the collection.
    DurationThe amount of time it took to collect the data.
    Last RunThe date and time when the run started.
    Total DataThe amount of data that the run collected.

Delete dashboard

Tanium Managed dashboards cannot be deleted.

  1. From the Main menu, go to Data > Dashboards.
  2. Choose one of the following:
    • Select the checkbox next to the dashboard and click Delete.
    • Click the dashboard to view the dashboard. In the upper right corner, click Delete.