Dashboard controls

In the Dashboard controls section of the sidebar, you can add variables, annotation queries, dashboard links, and controls to filter and group data, without leaving the dashboard.

{{< figure src="/media/docs/grafana/dashboards/screenshot-dashboard-controls-v13.0.png" max-width="400px" alt="Dashboard controls in the Dashboard options sidebar view" >}}

Filter and group by

<!-- vale Grafana.Spelling = NO -->

{{< admonition type="note" >}} Filter and group by is currently in public preview. Grafana Labs offers limited support, and breaking changes might occur prior to the feature being made generally available.

This feature renames the Filters variable (formerly ad hoc filter) to Filter and Group by and extends it by adding grouping for Prometheus and Loki data sources. However, in the dashboard schema, it is still referred to as "kind": "AdhocVariable".

To use this feature, enable the dashboardUnifiedDrilldownControls feature toggle in your Grafana configuration file.

For information on the generally available filters experience, refer to the Variables documentation. While that documentation reflects the generally available experience, the information applies to the filter and group by feature as well. {{< /admonition >}}

<!-- vale Grafana.Spelling = YES -->

The filter and group by is one of the most complex and flexible variable options available. Instead of creating a variable for each dimension by which you want to filter, they automatically query your data source for available dimensions and let users add or remove filters and groupings on the dashboard dynamically. This allows you to quickly apply filters dashboard-wide.

The group by function allows you to then group data by keys, letting you split it up. Group by is typically used with aggregation queries, such as sum(your_metric_here), to split aggregated results by the selected dimensions. Then, you can use filters within panels to filter data in or out, drilling down further into the data.

The filter and group by feature lets you add label/value filters that are automatically added to all queries that use the specified data source. Unlike other variables, you don't use these filters in queries. Instead, you use them to write filters for existing queries.

The following data sources support filters. Data sources with an asterisk also support group by:

{{< column-list >}}

• Prometheus*
• Loki*
• InfluxDB
• Elasticsearch
• OpenSearch.
• Special Dashboard data source - Use this to apply filters to data from unsupported data sources.

{{< /column-list >}}

Add a filter and group by

To add a filter and group by, follow these steps:

1. Navigate to the dashboard you want to update.

2. Click Edit.

3. Click the Add new element icon (blue plus sign). . Click Filter and Group by.

4. Enter a Name for the filter.

5. (Optional) In the Label field, enter the display name for the filter drop-down list.

   If you don't enter a display name, then the drop-down list label is the filter name.

6. (Optional) In the Description field, enter a description of the filter. The description appears as an info icon tooltip next to the filter name on the dashboard.

   Descriptions support links. You can use Markdown-style links ([link text](https://example.com)) or paste bare URLs (https://example.com). Only http and https URLs are rendered as clickable links—other protocols are displayed as plain text.

7. Choose a Display option:

   • Above dashboard - The filter drop-down list displays above the dashboard with the filter Name or Label value. This is the default.
   • Above dashboard, label hidden - The filter drop-down list displays above the dashboard, but without showing the name of the filter.
   • Controls menu - The filter is displayed in the dashboard controls menu instead of above the dashboard. The dashboard controls menu appears as a button in the dashboard toolbar.
   • Hidden - No filter drop-down list is displayed on the dashboard.

8. Under the Filter options section of the page, set the following options:

   Option	Description
   Data source	Select a target data source in the drop-down list. You can also click Open advanced data source picker to see more options, including adding a data source (Admins only). For more information about data sources, refer to Add a data source.
   Default filters	Set a default key/value pair. Optional. In the dashboard filter control, the default value is indicated with an information icon.
   Enable group by	This option only appears if you selected a Prometheus or Loki data source. Toggle the switch on to enable data grouping.
   Default group by	Set a default key for the dashboard. Optional. In the dashboard filter control, the default value is indicated with an information icon.
   Use static key dimensions	To provide the filter dimensions as comma-separated values (CSV), toggle the switch on, and then enter the values in the space provided. Optional.
   Allow custom values	Toggle the switch on to allow dashboard users to add custom values to the filter and group by lists. Optional.

9. Click Save.

10. Enter an optional description of your dashboard changes, and then click Save.

11. Click Exit edit.

Now you can filter and group data on the dashboard.

You can remove and reset default filters and groupings, and see your recent ones:

{{< figure src="/media/docs/grafana/dashboards/screenshot-reset-default-v13.0.png" max-width="500px" alt="Dashboard with the filters and group by selections" caption="Reset default filters and group by selections" >}}

{{< figure src="/media/docs/grafana/screenshot-filters-group-recent-v13.0.png" max-width="500px" alt="Dashboard with the filters and group by selections" caption="Recent filter and group by settings" >}}

To see every active filter and grouping across the dashboard all at once, click the filter icon in the toolbar to open an overview. The overview lets you see your current filters and group by selections, search for specific keys, and adjust them without scrolling through the dashboard controls:

{{< figure src="/media/docs/grafana/screenshot-filters-overview-v12.0.png" max-width="500px" alt="Dashboard with the filters and group by selections" >}}

Add an operator and value for a key to add it as a filter or select the Group by checkbox to set a group by key. You can use a key for both a filter and a group by.

Group and filter from the panel

When the Group by switch is toggled on, you can also set a group by from a panel rather than from the dashboard-level control. Hover the cursor over any panel using the data source of the filter to show the Group by selector:

{{< figure src="/media/docs/grafana/dashboards/screenshot-panel-groupby-v13.0.png" max-width="550px" alt="Group by control on a panel" >}}

This can be helpful when you're working with a panel that's far away from the dashboard controls. Your selection is applied to the all the panels in the dashboard with the same data source.

You can also further filter a time series panel, which allows you to drill down further into your data. After setting your group by and splitting your data, click on a series in a panel and click Filter on this value or Filter out this value which will filter by the labels found on that series, which are related to the set group by values.

To enable this functionality, you need to add one or more overrides for the panel. In the following example, the override:

• Adds a regular expression, so that all fields are filterable
• Enables the Ad-hoc filterable switch

{{< figure src="/media/docs/grafana/dashboards/screenshot-panel-filter-override-v13.0.png" max-width="400px" alt="Field override making all fields filterable" >}}

However, you can create overrides to address specific fields. You can also do this programmatically by returning the data frame with the appropriate filterable property on the desired fields.

With the override in place, you can click a series on a time series panel and filter it in or out. The new filter is shown in the dashboard filter control and the it's applied to the whole dashboard.

{{< figure src="/media/docs/grafana/dashboards/screenshot-panel-filters-v13.0.png" max-width="675px" alt="Panel with tooltip open showing options to filter on a value or filter it out" >}}

Add variables

To add a variable, follow these steps:

{{< docs/list >}}

1. Navigate to the dashboard you want to update.
2. Click Edit.
3. Click + Add variable at the top of the dashboard or click the Add new element icon (blue plus sign) and select Variable.
4. Choose a variable type from the list.

{{< shared-snippet path="/docs/grafana/<GRAFANA_VERSION>/visualizations/dashboards/variables/add-template-variables/index.md" id="add-variable" >}}

1. Complete the variable configuration. For more detailed configuration information, click the one of the following links to complete the steps for adding your selected variable type:

{{< column-list >}}

• Query
• Custom
• Textbox
• Constant
• Data source
• Interval
• Switch

{{< /column-list >}}

1. Click Save.
2. (Optional) Enter a description of the changes you've made.
3. Click Save.
4. Click Exit edit.

{{< /docs/list >}}

For more detailed information on variables, refer to the full Variables documentation.

Add annotation queries

To add an annotation query, follow these steps:

{{< docs/list >}}

1. Navigate to the dashboard you want to update.

2. Click Edit.

3. Click the Add new element icon (blue plus sign).

4. Click Annotation query.

5. Enter a name for the annotation query.

   This name is given to the toggle that allows you to enable/disable showing annotation events from this query.

{{< shared-snippet path="/docs/grafana/<GRAFANA_VERSION>/visualizations/dashboards/build-dashboards/annotate-visualizations/index.md" id="add-annotation-query" >}}

1. To add a query, do one of the following:

   • Click Open query editor to open Annotation Query dialog box and write or construct a query. The annotation query options are different for each data source. For information about annotations in a specific data source, refer to the specific data source topic.
   • Click Use saved query to open a the Saved queries drawer and select a saved query.

   {{< admonition type="note" >}} Saved queries is currently in public preview in Grafana Enterprise and Grafana Cloud only. {{< /admonition >}}

2. (Optional) Click Test annotation query to ensure that the query is working properly.

3. Click Close when you've completed the query setup.

4. Click Save.

5. (Optional) Enter a description of the changes you've made.

6. Click Save.

7. Click Exit edit.

{{< /docs/list >}}

For more detailed information about annotations, refer to the full Annotations documentation.

Add links

For more detailed information on dashboard links, refer to the full Dashboard links documentation.

Add links to dashboards

To add a link to another dashboard at the top of your current dashboard, follow these steps:

{{< docs/list >}}

1. Navigate to the dashboard you want to update.
2. Click Edit.
3. Click the Add new element icon (blue plus sign).
4. Click Link.

{{< shared-snippet path="/docs/grafana/<GRAFANA_VERSION>/visualizations/dashboards/build-dashboards/manage-dashboard-links/index.md" id="add-dashboard-link" >}}

1. Click Save.
2. (Optional) Enter a description of the changes you've made.
3. Click Save.
4. Click Exit edit.

{{< /docs/list >}}

Add a URL link to a dashboard

Add a link to a URL at the top of your current dashboard. You can link to any available URL, including dashboards, panels, or external sites. You can even control the time range to ensure the user is zoomed in on the right data in Grafana.

To add a URL link to your dashboard, follow these steps:

{{< docs/list >}}

1. Navigate to the dashboard you want to update.
2. Click Edit.
3. Click the Add new element icon (blue plus sign).
4. Click Link.

{{< shared-snippet path="/docs/grafana/<GRAFANA_VERSION>/visualizations/dashboards/build-dashboards/manage-dashboard-links/index.md" id="url-dashboard-link" >}}

1. Click Save.
2. (Optional) Enter a description of the changes you've made.
3. Click Save.
4. Click Exit edit.

{{< /docs/list >}}

Manage dashboard controls

After you add dashboard controls, you can manage them from the dashboard options. In this view, the sidebar includes collapsible sections for variables (including filter and group by), annotations, and links, including hidden controls that aren't otherwise visible on the dashboard:

{{< figure src="/media/docs/grafana/dashboards/screenshot-dashboard-controls-mgmt-v13.0.png" max-width="450px" alt="Dashboard controls in the Dashboard options sidebar view" >}}

To manage dashboard controls, follow these steps:

1. Click the Dashboard options icon in the sidebar.

2. In the sidebar, expand the appropriate collapsible section.

3. Do one or more of the following:

   • Edit: Click Select on the control to open it in the sidebar so you can make updates.
   • Reorder: Drag and drop controls to reorder them.
   • Change display: Drag and drop controls between sub-sections Above dashboard, Controls menu, and Hidden to update the control display option. Note that links can't be hidden.

   {{< admonition type="tip" >}} To get back to controls management from configuration, click the Dashboard options icon. {{< /admonition >}}

4. Make any other changes as needed.

5. Click Save.

6. (Optional) Enter a description of the changes you've made.

7. Click Save.

8. Click Exit edit.