grafana/docs/sources/search/_index.md
Jack Baldry c1c48dd610
Use relative aliases for all non-current Grafana aliases (#60062)
* Use relative aliases for all non-current Grafana aliases

Prevents non-latest documentation "stealing" the page away from latest
and through permanent redirects for latest pages that no longer exist.

The redirected pages are indexed by search engines but our robots.txt
forbids them crawling the non-latest page.

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Remove aliases from shared pages

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Rewrite all current latest aliases to be next

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Fix typo in latest alias

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Remove all current page aliases

find docs/sources -type f -name '*.md' -exec sed -z -i 's#\n *- /docs/grafana/next/[^\n]*\n#\n#' {} \;
find docs/sources -type f -name '*.md' -exec sed -Ez -i 's#\n((aliases:\n *-)|aliases:\n)#\n\2#' {} \;

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

* Prettier

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>

Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
2022-12-09 12:36:04 -04:00

3.4 KiB

aliases description keywords menutitle title weight
./
Learn how to search for Grafana dashboards
search
dashboard
Search Search 80

Search dashboards

You can search for dashboards by dashboard name and by panel title. When you search for dashboards, 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 dashboards using dashboard name

Begin typing any part of the dashboard name in the search bar. The search returns results for any partial string match in real-time, as you type.

Dashboard search is:

  • Real-time
  • Not case sensitive
  • Functional across stored and file based dashboards.

Note

: You can use your keyboard arrow keys to navigate the results and press Enter to open the selected dashboard.

The following image shows the search results when you search using dashboard name.

{{< figure src="/static/img/docs/v91/dashboard-features/search-by-dashboard-name.png" width="700px" >}}

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.

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" >}}).

  2. Locate the [feature_toggles]({{< relref "../setup-grafana/configure-grafana/#feature_toggles" >}}) section.

  3. Add the following parameter to the feature_toggles section:

    [feature_toggles]
    # enable features, separated by spaces
    enable = dashboardPreviews
    
  4. 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.

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.