Dashboard Scope

Dashboard and panel scope defines what data is valid for aggregation and display within the dashboard. The scope can be set at a dashboard-wide level, or overridden for individual panels, by any user type except for View Only users.

The current scope is displayed in the top left-hand corner of the module screen:

For more information on how scopes work, refer to the Grouping, Scoping, and Segmenting Metrics documentation.

Configure Dashboard Scope

To configure the scope of an existing dashboard:

  1. From the Dashboard module, select the relevant dashboard from the dashboard list.

  2. Click the Edit Scope link in the top right of the module screen:

  3. Open the first level drop-down menu.

  4. Select the first level label either by clicking the desired label, or searching for the label, then clicking it.

  5. Define how the value relates to the label, and define the value.

    Scope editor restricts the scope of the selection for subsequent filters by rendering values that are specific to the selected labels. For example, if the value of the kubernetes.namespace.name label is kube-system, the values of the subsequent label, container.name will be filtered by kube-system. This means the containers rendered for filtering are only those that are part of the kube-system namespace.

  6. Optional: Dashboard Templating.

    Dashboard scope values can be defined as variables, allowing users to create a template, and use one dashboard for multiple outputs. For example, in the image below, the kubernetes.namespace.name label is set as a variable:

    Once saved, the dashboard has multiple values that can be displayed:

  7. Optional: Add additional label/value combinations to further refine the scope.

  8. Click the Save button to save the new scope, or click the Cancel button to revert the changes.

    To reset the dashboard scope to the entire infrastructure, or to update an existing dashboard’s scope to the entire infrastructure, open the first scope drop-down menu and select everywhere.

Configure Panel Scope

To configure the scope of an existing dashboard panel:

  1. From the Dashboard module, select the relevant dashboard from the dashboard list.

  2. Hover the cursor over the desired panel, and select the Edit (pencil) icon:

  3. Click the Override Dashboard Scope link to enable a custom panel scope.

    To return an individual panel scope to the default dashboard scope, click the Default to Dashboard Scope link, and save the changes.

  4. Open the Scope drop-down menu.

  5. Either select the new scope, or search for the desired scope, and then select it.

  6. Click the Save button to confirm the changes.

Panels that have a custom scope (a different scope to the overall dashboard) are marked with a shaded corner:

Last modified September 23, 2021