IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2024-11-22 08:56:43 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #7 from mattttt/mattttt-docs

Browse Source 
Mattttt docs
This commit is contained in:
Matt 2015-08-11 14:41:21 -04:00
commit d132d3abfd
4 changed files with 31 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/sources/reference/dashlist.md
View File

@ -8,25 +8,26 @@ page_keywords: grafana, dashlist, panel, documentation
## Overview
The dashboard list panel allows you to show a list of links to other dashboards. The list can be based on a search query or dashboard tag query. You can also configure it to show your starred
dashboards.
The dashboard list panel allows you to display dynamic links to other dashboards. The list can be configured to use starred dashbaords, a search query and/or dashboard tags.
<img class="no-shadow" src="/img/v2/dashboard_list_panels.png" style="width:80%;">
<img class="no-shadow" src="/img/v2/dashboard_list_panels.png">
> On each dashboard load, the dashlist panel will re-query the dashboard list, always providing the most up to date results.
## Mode: Starred Dashboards
The `starred` dashboard selection displays starred dashboards, up to the number specified in the `Limit Number to` field, in alphabetical order. On dashboard load, the dashlist panel will re-query the favorites to appear in dashboard list panel, always providing the most up to date results.
<img class="no-shadow" src="/img/v2/dashboard_list_config_starred.png">
## Options
## Mode: Search Dashboards
### Mode: Starred Dashboards
The panel may be configured to search by either string query or tag(s). On dashboard load, the dashlist panel will re-query the dashboard list, always providing the most up to date results.
The `starred` dashboard selection will display starred dashboards in alphabetical order, up to the number selected in the `Limit Number to` field. As new starred dashboards are added, the Dashlist Panel will automatically update.
To configure dashboard list in this manner, select `search` from the Mode select box. When selected, the Search Options section will appear.
### Mode: Search Dashboards
Dashboard lists may be configured by either a string search query or tag. On each dashboard load, the dashlist panel will re-query the dashboard list, always providing the most up to date results.
To configure dashboard list in this manner, select `search` from the Mode select box. When properly selected, the Search Options section will appear.
Name | Description
------------ | -------------
Mode | Set search or starred mode
@ -35,17 +36,16 @@ Tags | if in search mode specify dashboard tags to search for
Limit number to | Specify the maximum number of dashboards
#### Search by string
To search by a string, enter a search query in the `Search Options: Query:` field. Queries are non-case sensitive, and partial values are accepted. On each dashboard load, the dashlist panel will re-query the dashboard list, always providing the most up to date results of the search string.
### Search by string
To search by a string, enter a search query in the `Search Options: Query` field. Queries are case-insensitive, and partial values are accepted.
<img class="no-shadow" src="/img/v2/dashboard_list_config_string.png">
#### Search by tag
To search by a string, enter a search query in the `Search Options: Query:` field. Queries are non-case sensitive, and partial values are accepted.
### Search by tag
To search by one or more tags, enter your selection in the `Search Options: Tags:` field. Note that existing tags will not appear as you type, and *are* case sensitive. To see a list of existing tags, you can always return to the dashboard, open the Dashboard Picker at the top and click `tags` link in the search bar.
<img class="no-shadow" src="/img/v2/dashboard_list_config_tags.png">
When multiple tags and strings appear, the dashboard list will display those matching ALL conditions.
> When multiple tags and strings appear, the dashboard list will display those matching ALL conditions.

9
docs/sources/reference/export_import.md
View File

@ -18,7 +18,7 @@ To export a dashboard, locate the settings menu within the desired dashboard and
#### Copy JSON
The raw JSON may be accessed directly from within the interface and copy/pasted into an editor of your choice to be saved later. To view this JSON, locate the settings menu within the desired dashboard and click the gear icon. The View JSON option will always be available, and will open the raw JSON in a text area. To copy the entire JSON file, click into the text area, the select all [CTRL+A (PC, Linux) or CMD+A (Mac)].
The raw JSON may be accessed directly from within the interface and copy/pasted into an editor of your choice to be saved later. To view this JSON, locate the settings menu within the desired dashboard and click the gear icon. The View JSON option will always be available, and will open the raw JSON in a text area. To copy the entire JSON file, click into the text area, the select all `CTRL`+`A` (PC, Linux) or `⌘`+`A` (Mac).
<img class="no-shadow" src="/img/v2/export-2.gif">
@ -55,10 +55,11 @@ In the Import view you find the section `Migrate dashboards`. Pick the data sour
Your dashboards should be automatically imported into the Grafana 2.0 back-end. Dashboards will no longer be stored in your previous Elasticsearch or InfluxDB databases.
### Troubleshooting
## Troubleshooting
#### Common issues when importing/exporting from a file.
Note: When importing a dashboard, keep an eye out for template variables that may not exist in your instance of Grafana. For example,
### Template variables could not be initialized.
When importing a dashboard, keep an eye out for template variables in your JSON that may not exist in your instance of Grafana. For example,
"templating": {
"list": [

2
docs/sources/reference/keyboard_shortcuts.md
View File

@ -29,4 +29,4 @@ Press `Shift`+`?` to open the keyboard shortcut dialog from anywhere within the
**Note**: Grafana keyboard shortcuts are the same across operating system. For example, `CTRL`+`F` will open the dashboard picker on a Mac as well, **not** `⌘`+`F`
Have a suggestion for a new keyboard shortcut? Let us know!
Have a suggestion for a new keyboard shortcut? Let us know.

14
docs/sources/reference/search.md
View File

@ -8,7 +8,7 @@ page_keywords: grafana, search, guide, documentation
Dashboards can be searched by the dashboard name, filtered by one (or many) tags or filtered by starred status. The dashboard search is accessed through the dashboard picker, available in the dashboard top nav area.
<img class="no-shadow" src="/img/v2/dashboard_search.jpg">
<img class="no-shadow" src="/img/v2/dashboard_search.png">
1. `Dashboard Picker`: The Dashboard Picker is your primary navigation tool to move between dashboards. It is present on all dashboards, and open the Dashboard Search. The dashboard picker also doubles as the title of the current dashboard.
2. `Search Bar`: The search bar allows you to enter any string and search both database and file based dashbaords in real-time.
@ -30,16 +30,16 @@ Dashboard search is:
## Filter by Tag(s)
If you have a lot of dashboards use tags to organize them. You can add tags in the dashboards settings modal.
Tags are a great way to organize your dashboards, especially as the number of dashbaords grow. Tags can be added and managed in the dashboard `Settings`.
To filter the dashboard list by tag, click on any tag appearing in the right column. The list may be further filtered by cliking on additional tags:
<img class="no-shadow" src="/img/v2/dashboard_search_tag_filtering.gif">
To filter the dashboard list by tag, click on any tag appearing in the right column. The list may be further filtered by cliking on additional tags.
Alternately, to see a list of all available tags, click the tags link in the search bar. All tags will be shown, and when a tag is selected, the dashboard search will be instantly filtered:
<img class="no-shadow" src="/img/v2/dashboard_search_tags_all_filtering.gif">
Alternately, to see a list of all available tags, click the tags link in the search bar. All tags will be shown, and when a tag is selected, the dashboard search will be instantly filtered.
When using only a keybaord: `tab` to focus on the *tags* link, `▼` down arrow key to find a tag and select with the `Enter` key.
**Note**: When multiple tags are selected, Grafana will show dashboards that include **all**.
@ -47,8 +47,8 @@ When using only a keybaord: `tab` to focus on the *tags* link, `▼` down arrow
## Filter by Starred
Starring is a great way to organize and find commonly used dashboards. To show only starred dashboards in the list, click the *starred* link in the search bar:
<img class="no-shadow" src="/img/v2/dashboard_search_starred_filtering.gif">
Starring is a great way to organize and find commonly used dashboards. To show only starred dashboards in the list, click the *starred* link in the search bar.
When using only a keybaord: `tab` to focus on the *stars* link, `▼` down arrow key to find a tag and select with the `Enter` key.