mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
Docs: Restructure Search content (#93636)
This commit is contained in:
Isabel Matwawana
GitHub
parent
a0122187b0
commit
1cbe8772c2
@ -17,7 +17,7 @@ labels:
|
||||
- cloud
|
||||
- enterprise
|
||||
title: Assess dashboard usage
|
||||
weight: 200
|
||||
weight: 900
|
||||
refs:
|
||||
grafana-enterprise:
|
||||
- pattern: /docs/grafana/
|
||||
|
||||
@ -14,7 +14,7 @@ labels:
|
||||
menuTitle: Build dashboards
|
||||
title: Build dashboards
|
||||
description: Build dashboards including managing settings, links, and version history
|
||||
weight: 2
|
||||
weight: 200
|
||||
refs:
|
||||
variables:
|
||||
- pattern: /docs/grafana/
|
||||
|
||||
@ -22,7 +22,7 @@ labels:
|
||||
- oss
|
||||
menuTitle: Manage dashboard links
|
||||
title: Manage dashboard links
|
||||
weight: 500
|
||||
weight: 200
|
||||
refs:
|
||||
data-links:
|
||||
- pattern: /docs/grafana/
|
||||
|
||||
@ -15,7 +15,7 @@ labels:
|
||||
menuTitle: Manage playlists
|
||||
title: Manage playlists
|
||||
description: Create and manage dashboard playlists
|
||||
weight: 9
|
||||
weight: 500
|
||||
---
|
||||
|
||||
# Manage playlists
|
||||
|
||||
@ -17,7 +17,7 @@ labels:
|
||||
menuTitle: Reporting
|
||||
title: Create and manage reports
|
||||
description: Generate and share PDF reports from your Grafana dashboards
|
||||
weight: 85
|
||||
weight: 600
|
||||
refs:
|
||||
repeat-panels-or-rows:
|
||||
- pattern: /docs/grafana/
|
||||
|
||||
@ -6,7 +6,7 @@ labels:
|
||||
- oss
|
||||
title: Public dashboards
|
||||
description: Make your Grafana dashboards public and share them with anyone
|
||||
weight: 8
|
||||
weight: 350
|
||||
refs:
|
||||
dashboard-sharing:
|
||||
- pattern: /docs/grafana/
|
||||
|
||||
@ -19,7 +19,7 @@ labels:
|
||||
menuTitle: Manage dashboards
|
||||
title: Manage dashboards
|
||||
description: Learn about dashboard management and generative AI features for dashboards
|
||||
weight: 8
|
||||
weight: 300
|
||||
refs:
|
||||
build-dashboards:
|
||||
- pattern: /docs/grafana/
|
||||
|
||||
109
docs/sources/dashboards/search-dashboards/index.md
Normal file
109
docs/sources/dashboards/search-dashboards/index.md
Normal file
@ -0,0 +1,109 @@
|
||||
---
|
||||
description: Learn how to search for Grafana dashboards and folders
|
||||
keywords:
|
||||
- search
|
||||
- dashboard
|
||||
- folder
|
||||
labels:
|
||||
products:
|
||||
- cloud
|
||||
- enterprise
|
||||
- oss
|
||||
menutitle: Search dashboards
|
||||
title: Search dashboards and folders
|
||||
weight: 400
|
||||
---
|
||||
|
||||
# Search dashboards and folders
|
||||
|
||||
You can search for dashboards and dashboard folders by name.
|
||||
|
||||
When you search for dashboards, you can also do it by panel title. Whether you search by name or panel title, the system returns all dashboards available within the Grafana instance, even if you do not have permission to view the contents of the dashboard.
|
||||
|
||||
## Search by name
|
||||
|
||||
Begin typing any part of the dashboard or folder name in the search bar. The search returns results for any partial string match in real-time, as you type.
|
||||
|
||||
The search is:
|
||||
|
||||
- Real-time
|
||||
- _Not_ case sensitive
|
||||
- Functional across stored _and_ file based dashboards and folders.
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
You can use your keyboard arrow keys to navigate the results and press `Enter` to open the selected dashboard or folder.
|
||||
{{% /admonition %}}
|
||||
|
||||
The following images show:
|
||||
|
||||
Searching by dashboard name from the **Dashboards** page.
|
||||
|
||||
{{< figure src="/media/docs/grafana/dashboards/search-for-dashboard.png" width="700px" >}}
|
||||
|
||||
Searching by folder name from the **Dashboards** page.
|
||||
|
||||
{{< figure src="/media/docs/grafana/dashboards/search-folder.png" width="700px" >}}
|
||||
|
||||
Searching by dashboard name inside a folder.
|
||||
|
||||
{{< figure src="/media/docs/grafana/dashboards/search-in-folder.png" width="700px" >}}
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
When you search within a folder, its subfolders are not part of the results returned. You need to be on the **Dashboards** page (or the root level) to search for subfolders by name.
|
||||
{{% /admonition %}}
|
||||
|
||||
## Search dashboards using panel title
|
||||
|
||||
You can search for a dashboard by the title of a panel that appears in a dashboard.
|
||||
If a panel's title matches your search query, the dashboard appears in the search results.
|
||||
|
||||
This feature is available by default in Grafana Cloud and in Grafana OSS v9.1 and higher, you access this feature by enabling the `panelTitleSearch` feature toggle.
|
||||
For more information about enabling panel title search, refer to [Enable the panelTitleSearch feature toggle.](#enable-panelTitleSearch-feature-toggle)
|
||||
|
||||
The following image shows the search results when you search using panel title.
|
||||
|
||||
{{< figure src="/static/img/docs/v91/dashboard-features/search-by-panel-title.png" width="700px" >}}
|
||||
|
||||
### Enable the panelTitleSearch feature toggle
|
||||
|
||||
Complete the following steps to enable the `panelTitleSearch` feature toggle.
|
||||
|
||||
**Before you begin:**
|
||||
|
||||
- If you are running Grafana Enterprise with RBAC, enable [service accounts]({{< relref "../administration/service-accounts/" >}}).
|
||||
|
||||
**To enable the panelTitleSearch feature toggle:**
|
||||
|
||||
1. Open the Grafana [configuration file]({{< relref "../setup-grafana/configure-grafana/#configuration-file-location" >}}).
|
||||
|
||||
1. Locate the [feature_toggles]({{< relref "../setup-grafana/configure-grafana/#feature_toggles" >}}) section.
|
||||
|
||||
1. Add the following parameter to the `feature_toggles` section:
|
||||
|
||||
```
|
||||
[feature_toggles]
|
||||
# enable features, separated by spaces
|
||||
enable = panelTitleSearch
|
||||
```
|
||||
|
||||
1. Save your changes and restart the Grafana server.
|
||||
|
||||
## Filter dashboard search results by tag(s)
|
||||
|
||||
Tags are a great way to organize your dashboards, especially as the number of dashboards grow. You can add and manage tags in dashboard `Settings`.
|
||||
|
||||
When you select multiple tags, Grafana shows dashboards that include all selected tags.
|
||||
|
||||
To filter dashboard search result by a tag, complete one of the following steps:
|
||||
|
||||
- To filter dashboard search results by tag, click a tag that appears in the right column of the search results.
|
||||
|
||||
You can continue filtering by clicking additional tags.
|
||||
|
||||
- To see a list of all available tags, click the **Filter by tags** dropdown menu and select a tag.
|
||||
|
||||
All tags will be shown, and when you select a tag, the dashboard search will be instantly filtered.
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
When using only a keyboard, press the `tab` key and navigate to the **Filter by tag** drop-down menu, press the down arrow key `▼` to activate the menu and locate a tag, and press `Enter` to select the tag.
|
||||
{{% /admonition %}}
|
||||
@ -32,7 +32,7 @@ labels:
|
||||
menuTitle: Sharing
|
||||
title: Share dashboards and panels
|
||||
description: Share Grafana dashboards and panels within your organization and publicly
|
||||
weight: 85
|
||||
weight: 700
|
||||
refs:
|
||||
image-rendering:
|
||||
- pattern: /docs/grafana/
|
||||
|
||||
@ -16,7 +16,7 @@ labels:
|
||||
menuTitle: Troubleshoot dashboards
|
||||
title: Troubleshoot dashboards
|
||||
description: Learn how to troubleshoot common dashboard issues
|
||||
weight: 300
|
||||
weight: 1000
|
||||
---
|
||||
|
||||
# Troubleshoot dashboards
|
||||
|
||||
@ -19,7 +19,7 @@ labels:
|
||||
menuTitle: Use dashboards
|
||||
title: Use dashboards
|
||||
description: Learn about the features of a Grafana dashboard
|
||||
weight: 1
|
||||
weight: 100
|
||||
refs:
|
||||
dashboard-analytics:
|
||||
- pattern: /docs/grafana/
|
||||
|
||||
@ -10,7 +10,7 @@ labels:
|
||||
- oss
|
||||
title: Variables
|
||||
description: Add variables to metric queries and panel titles to create interactive and dynamic dashboards
|
||||
weight: 130
|
||||
weight: 800
|
||||
---
|
||||
|
||||
# Variables
|
||||
|
||||
@ -1,9 +1,11 @@
|
||||
---
|
||||
description: Learn how to search for Grafana dashboards and folders
|
||||
description: Use the command palette to search all of Grafana and initiate key actions
|
||||
keywords:
|
||||
- search
|
||||
- dashboard
|
||||
- folder
|
||||
- dashboards
|
||||
- alerts
|
||||
- preferences
|
||||
- sift
|
||||
labels:
|
||||
products:
|
||||
- cloud
|
||||
@ -14,111 +16,24 @@ title: Search
|
||||
weight: 80
|
||||
---
|
||||
|
||||
# Search dashboards and folders
|
||||
# Grafana search
|
||||
|
||||
You can search for dashboards and dashboard folders by name.
|
||||
|
||||
When you search for dashboards, you can also do it by panel title. Whether you search by name or panel title, the system returns all dashboards available within the Grafana instance, even if you do not have permission to view the contents of the dashboard.
|
||||
|
||||
## Search by name
|
||||
|
||||
Begin typing any part of the dashboard or folder name in the search bar. The search returns results for any partial string match in real-time, as you type.
|
||||
|
||||
The search is:
|
||||
|
||||
- Real-time
|
||||
- _Not_ case sensitive
|
||||
- Functional across stored _and_ file based dashboards and folders.
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
You can use your keyboard arrow keys to navigate the results and press `Enter` to open the selected dashboard or folder.
|
||||
{{% /admonition %}}
|
||||
|
||||
The following images show:
|
||||
|
||||
Searching by dashboard name from the **Dashboards** page.
|
||||
|
||||
{{< figure src="/media/docs/grafana/dashboards/search-for-dashboard.png" width="700px" >}}
|
||||
|
||||
Searching by folder name from the **Dashboards** page.
|
||||
|
||||
{{< figure src="/media/docs/grafana/dashboards/search-folder.png" width="700px" >}}
|
||||
|
||||
Searching by dashboard name inside a folder.
|
||||
|
||||
{{< figure src="/media/docs/grafana/dashboards/search-in-folder.png" width="700px" >}}
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
When you search within a folder, its subfolders are not part of the results returned. You need to be on the **Dashboards** page (or the root level) to search for subfolders by name.
|
||||
{{% /admonition %}}
|
||||
|
||||
## Search dashboards using panel title
|
||||
|
||||
You can search for a dashboard by the title of a panel that appears in a dashboard.
|
||||
If a panel's title matches your search query, the dashboard appears in the search results.
|
||||
|
||||
This feature is available by default in Grafana Cloud and in Grafana OSS v9.1 and higher, you access this feature by enabling the `panelTitleSearch` feature toggle.
|
||||
For more information about enabling panel title search, refer to [Enable the panelTitleSearch feature toggle.](#enable-panelTitleSearch-feature-toggle)
|
||||
|
||||
The following image shows the search results when you search using panel title.
|
||||
|
||||
{{< figure src="/static/img/docs/v91/dashboard-features/search-by-panel-title.png" width="700px" >}}
|
||||
|
||||
### Enable the panelTitleSearch feature toggle
|
||||
|
||||
Complete the following steps to enable the `panelTitleSearch` feature toggle.
|
||||
|
||||
**Before you begin:**
|
||||
|
||||
- If you are running Grafana Enterprise with RBAC, enable [service accounts]({{< relref "../administration/service-accounts/" >}}).
|
||||
|
||||
**To enable the panelTitleSearch feature toggle:**
|
||||
|
||||
1. Open the Grafana [configuration file]({{< relref "../setup-grafana/configure-grafana/#configuration-file-location" >}}).
|
||||
|
||||
1. Locate the [feature_toggles]({{< relref "../setup-grafana/configure-grafana/#feature_toggles" >}}) section.
|
||||
|
||||
1. Add the following parameter to the `feature_toggles` section:
|
||||
|
||||
```
|
||||
[feature_toggles]
|
||||
# enable features, separated by spaces
|
||||
enable = panelTitleSearch
|
||||
```
|
||||
|
||||
1. Save your changes and restart the Grafana server.
|
||||
|
||||
## Filter dashboard search results by tag(s)
|
||||
|
||||
Tags are a great way to organize your dashboards, especially as the number of dashboards grow. You can add and manage tags in dashboard `Settings`.
|
||||
|
||||
When you select multiple tags, Grafana shows dashboards that include all selected tags.
|
||||
|
||||
To filter dashboard search result by a tag, complete one of the following steps:
|
||||
|
||||
- To filter dashboard search results by tag, click a tag that appears in the right column of the search results.
|
||||
|
||||
You can continue filtering by clicking additional tags.
|
||||
|
||||
- To see a list of all available tags, click the **Filter by tags** dropdown menu and select a tag.
|
||||
|
||||
All tags will be shown, and when you select a tag, the dashboard search will be instantly filtered.
|
||||
|
||||
{{% admonition type="note" %}}
|
||||
When using only a keyboard, press the `tab` key and navigate to the **Filter by tag** drop-down menu, press the down arrow key `▼` to activate the menu and locate a tag, and press `Enter` to select the tag.
|
||||
{{% /admonition %}}
|
||||
Use the command palette to search all of Grafana and to initiate key actions from any page in the application.
|
||||
|
||||
## Command palette
|
||||
|
||||
The command palette enables you to:
|
||||
The command palette allows you to:
|
||||
|
||||
- Search for and open dashboards and folders
|
||||
- Create dashboards and alert rules
|
||||
- Locate pages within Grafana
|
||||
- Change the theme to dark or light
|
||||
- Run Sift investigations
|
||||
|
||||
|
||||
|
||||
To open the command palette, press `cmd+K` in macOS or `ctrl+k` in Linux/Windows. You can also click on the input located in the navigation bar.
|
||||
|
||||
> **Note:** To go to the previous step, press `backspace` with the command palette input empty.
|
||||
{{< admonition type="note">}}
|
||||
To go to the previous step, press `backspace` with the command palette input empty.
|
||||
{{< /admonition >}}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user