Skip to content

Commit e926a4c

Browse files
committed
Dashboard Scope based variable info added
1 parent 772f944 commit e926a4c

File tree

6 files changed

+22
-1
lines changed

6 files changed

+22
-1
lines changed

docs/dashboards/filter-template-variables.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,12 @@ In the Dashboard top menu bar, click the filter icon to show the variables optio
2929

3030
## Create a template variable
3131

32-
There are three types of template variables you can use as a dashboard filter:
32+
There are four types of template variables you can use as a dashboard filter:
3333

3434
* Custom List - a custom set of options
3535
* Metrics Metadata Search - metrics metadata based options 
3636
* Log Search - logs query based options
37+
* Scope-based Variable - define scope variables to automatically apply to all log quieries
3738

3839
### Add a Custom List variable
3940

@@ -46,6 +47,7 @@ To add a Custom List variable to a dashboard, do the following:
4647
1. In the **Create Template Variable** panel, enter a unique **Variable Name**. Spaces and special characters, with the exception of an underscore (_), are not allowed in value names.<br/><img src={useBaseUrl('img/dashboards/filter-template-variables/Create-Template-Variable-dialog.png')} style={{border:'1px solid gray'}} alt="Create-Template-Variable-dialog" width="800"/>
4748
1. Select **Custom List** as the **Variable Type**.
4849
1. **List Items** are your variable values. Use a comma separated list for variable options, separating individual options with a comma. For example, `small, medium, large`.
50+
1. (Optional) **Include the option to select all values (\*)** will be selected by default. This includes a wildcard asterisk (\*) in the available options.
4951
1. (Optional) Provide a **Default Value** for the variable.
5052
1. Click **Create Template Variable** to apply the variable to the dashboard. 
5153

@@ -61,6 +63,7 @@ To add a Metrics Metadata Search variable to a dashboard, do the following:
6163
1. Select **Metrics Metadata Search** as the **Variable Type**.
6264
1. The **Fields (key)** is the metadata field you want to use as the filter.
6365
1. (Optional) **Filters** allow you to filter the scope of your data before choosing the field you want to use. Click in the **Filter** input, begin typing, and choose a filter from the pop-up list. A list of valid values appears. Select a value for the filter, and add other filters as needed.
66+
1. (Optional) **Include the option to select all values (\*)** will be selected by default. This includes a wildcard asterisk (\*) in the available options.
6467
1. (Optional) Provide a **Default Value** for the variable.
6568
1. Click **Create Template Variable** to apply the variable to the dashboard.
6669

@@ -76,6 +79,24 @@ To add a Logs Search variable to a dashboard, do the following:
7679
1. Select **Logs Search** as the **Variable Type**.
7780
1. Click in the **Query** field and begin typing your query. Select valid options from the pop-up list as they appear until your query is complete.
7881
1. The **Key** is the metadata field you want to use as the filter. Once a Key is selected the Preview table will show example values based on the query running for the last 15 minutes.
82+
1. (Optional) **Include the option to select all values (\*)** will be selected by default. This includes a wildcard asterisk (\*) in the available options.
83+
1. (Optional) Enter a **Default Value** for the variable.
84+
1. Click **Create Template Variable** to apply the variable to the dashboard.
85+
86+
### Add a Scope-based Variable
87+
88+
With Scope-based variables, you can define a variable automatically applies to all log queries within the scope of the dashboard or panels. With this you can define the key while creating the scope variable and users can select the appropriate value to implement simple filtering for the dashboard. Additionally with Scope-based variables, you can select the specific panels to which the scope variable should be applied.
89+
90+
To add a Scope-based variable to a dashboard, do the following:
91+
92+
1. In the Dashboard top menu bar, click the filter icon to show the variables option. The filter icon allows you to toggle if the variables option is displayed or hidden.<br/><img src={useBaseUrl('img/dashboards/filter-template-variables/Show-and-Hide-filters.png')} style={{border:'1px solid gray'}} alt="Show-and-Hide-filters" width="250"/>
93+
1. In the Dashboard top menu bar, click the **plus (+) icon**. The **Create Template Variable** panel appears.<br/><img src={useBaseUrl('img/dashboards/filter-template-variables/create-dashboard-filter.png')} style={{border:'1px solid gray'}} alt="create-dashboard-filter" width="800"/>
94+
1. In the **Create Template Variable** panel, enter a unique **Variable Name**. Spaces and special characters, with the exception of an underscore (_), are not allowed in value names.<br/><img src={useBaseUrl('img/dashboards/filter-template-variables/scope-based-varibale.png')} style={{border:'1px solid gray'}} alt="scope-based-varibale" width="800"/>
95+
1. Select **Scope-based Variable** as the **Variable Type**.
96+
1. The **Filds (key)** is the metadata field you want to use as the filter. Once a Key is selected the Preview table will show example values based on the query running for the last 15 minutes.
97+
1. (Optional) **Display all values available** will be selected by default. If you want to specify any values, deselect this option and enter the required value(s) in section below.
98+
1. (Optional) **Apply filter to all panels in dashboard** will be selected by default. If you want to apply this variable to secleted panel, deselect this option and select the panels from the dropdown. You can also click on <img src={useBaseUrl('img/dashboards/filter-template-variables/preview-the-panels.png')} style={{border:'1px solid gray'}} alt="preview-the-panels" width="30"/> to preview and select the dashboard panel to which you want to apply this varibale.
99+
1. (Optional) **Include the option to select all values (\*)** will be selected by default. This includes a wildcard asterisk (\*) in the available options.
79100
1. (Optional) Enter a **Default Value** for the variable.
80101
1. Click **Create Template Variable** to apply the variable to the dashboard.
81102

-7.32 KB
Loading
25.6 KB
Loading
-3.92 KB
Loading
4.3 KB
Loading
188 KB
Loading

0 commit comments

Comments
 (0)