mirror of https://github.com/grafana/grafana
Merge branch 'master' of https://github.com/mattttt/grafana
Conflicts: docs/sources/installation/debian.md docs/sources/installation/ldap.mdpull/2502/head
Torkel Ödegaard
10 years ago
commit
5aee981590
@ -0,0 +1,22 @@ |
||||
---- |
||||
page_title: Data Source Overview |
||||
page_description: Data Source Overview |
||||
page_keywords: grafana, graphite, influxDB, KairosDB, OpenTSDB, documentation |
||||
--- |
||||
|
||||
# Data Source Overview |
||||
Grafana supports many different storage backends for your time series data (Data Source). Each Data Source has a specific Query Editor that is customized for the features and capabilities that the particular Data Source exposes. |
||||
|
||||
|
||||
## Querying |
||||
The query language and capabilities of each Data Source are obviously very different. You can combine data from multiple Data Sources onto a single Dashboard, but each Panel is tied to a specific Data Source that belongs to a particular Organization. |
||||
|
||||
## Supported Data Sources |
||||
The following datasources are officially supported: |
||||
|
||||
* [Graphite](/datasources/graphite/) |
||||
* [InfluxDB](/datasources/influxdb/) |
||||
* [OpenTSDB](/datasources/opentsdb/) |
||||
* [KairosDB](/datasources/kairosdb) |
||||
|
||||
Grafana can query any Elasticsearch index for annotation events, but at this time, it's not supported for metric queries. Learn more about [annotations](/reference/annotations/#elasticsearch-annotations) |
||||
@ -0,0 +1,96 @@ |
||||
---- |
||||
page_title: Graphite query guide |
||||
page_description: Graphite query guide |
||||
page_keywords: grafana, graphite, metrics, query, documentation |
||||
--- |
||||
|
||||
# Basic Concepts |
||||
|
||||
This document is a “bottom up” introduction to basic concepts in Grafana, and can be used as a starting point to get familiar with core features. |
||||
|
||||
|
||||
### ** Data Source ** |
||||
Grafana supports many different storage backends for your time series data (Data Source). Each Data Source has a specific Query Editor that is customized for the features and capabilities that the particular Data Source exposes. |
||||
|
||||
The following datasources are officially supported: [Graphite](/datasources/graphite/), [InfluxDB](/datasources/influxdb/), [OpenTSDB](/datasources/opentsdb/), and [KairosDB](/datasources/kairosdb) |
||||
|
||||
The query language and capabilities of each Data Source are obviously very different. You can combine data from multiple Data Sources onto a single Dashboard, but each Panel is tied to a specific Data Source that belongs to a particular Organization. |
||||
|
||||
### ** Organization ** |
||||
Grafana supports multiple organizations in order to support a wide variety of deployment models, including using a single Grafana instance to provide service to multiple potentially untrusted Organizations. |
||||
|
||||
In many cases, Grafana will be deployed with a single Organization. |
||||
|
||||
Each Organization can have one or more Data Sources. |
||||
|
||||
All Dashboards are owned by a particular Organization. |
||||
|
||||
> Note: It is important to remember that most metric databases to not provide any sort of per-user series authentication. Therefore, in Grafana, Data Sources and Dashboards are available to all Users in a particular Organization. |
||||
|
||||
For more details on the user model for Grafana, please refer to [Admin](/reference/admin/) |
||||
|
||||
### ** User ** |
||||
A User is a named account in Grafana. A user can belong to one or more Organizations, and can be assigned different levels of privileges through roles. |
||||
|
||||
Grafana supports a wide variety of internal and external ways for Users to authenticate themselves. These include from its own integrated database, from an external SQL server, or from an external LDAP server. |
||||
|
||||
For more details please refer to [User Auth](/reference/http_api/#users) |
||||
|
||||
### ** Row ** |
||||
|
||||
A Row is a logical divider within a Dashboard, and is used to group Panels together. |
||||
|
||||
Rows are always 12 “units” wide. These units are automatically scaled dependent on the horizontal resolution of your browser. You can control the relative width of Panels within a row by setting their own width. |
||||
|
||||
We utilize a unit abstraction so that Grafana looks great on all screens both small and huge. |
||||
|
||||
> Note: With MaxDataPoint functionality, Grafana can show you the perfect amount of datapoints no matter your resolution or time-range. |
||||
|
||||
Utilize the [Repeating Row functionality](/reference/templating/#utilizing-template-variables-with-repeating-panels-and-repeating-rows) to dynamically create or remove entire Rows (that can be filled with Panels), based on the Template variables selected. |
||||
|
||||
Rows can be collapsed by clicking on the Row Title. If you save a Dashboard with a Row collapsed, it will save in that state and will not preload those graphs until the row is expanded. |
||||
|
||||
### ** Panel ** |
||||
|
||||
The Panel is the basic visualization building block in Grafana. Each Panel provides a Query Editor (dependent on the Data Source selected in the panel) that allows you to extract the perfect visualization to display on the Panel by utilizing the Query Editor |
||||
|
||||
There are a wide variety of styling and formatting options that each Panel exposes to allow you to create the perfect picture. |
||||
|
||||
Panels can be dragged and dropped and rearranged on the Dashboard. They can also be resized. |
||||
|
||||
There are currently four Panel types: [Graph](/reference/graph/), [Singlestat](/reference/singlestat/), [Dashlist](/reference/dashlist/), and [Text](/reference/text/). |
||||
|
||||
Panels like the [Graph](/reference/graph/) panel allow you to graph as many metrics and series as you want. Other panels like [Singlestat](/reference/singlestat/) require a reduction of a single query into a single number. [Dashlist](/reference/dashlist/) and [Text](/reference/text/) are special panels that do not connect to any Data Source. |
||||
|
||||
Panels can be made more dynamic by utilizing [Dashboard Templating](/reference/templating/) variable strings within the panel configuration (including queries to your Data Source configured via the Query Editor). |
||||
|
||||
Utilize the [Repeating Panel](/reference/templating/#utilizing-template-variables-with-repeating-panels-and-repeating-rows) functionality to dynamically create or remove Panels based on the [Templating Variables](/reference/templating/#utilizing-template-variables-with-repeating-panels-and-repeating-rows) selected. |
||||
|
||||
The time range on Panels is normally what is set in the [Dashboard time picker](/reference/timerange/) but this can be overridden by utilizes [Panel specific time overrides](/reference/timerange/#panel-time-override). |
||||
|
||||
Panels (or an entire Dashboard) can be [Shared](/reference/sharing/) easily in a variety of ways. You can send a link to someone who has a login to your Grafana. You can use the [Snapshot](/reference/sharing/#snapshots) feature to encode all the data currently being viewed into a static and interactive JSON document; it's so much better than emailing a screenshot! |
||||
|
||||
|
||||
### ** Query Editor ** |
||||
|
||||
The Query Editor exposes capabilities of your Data Source and allows you to query the metrics that it contains. |
||||
|
||||
Use the Query Editor to build one or more queries (for one or more series) in your time series database. The panel will instantly update allowing you to effectively explore your data in real time and build a perfect query for that particular Panel. |
||||
|
||||
You can utilize [Template variables]((reference/templating/) in the Query Editor within the queries themselves. This provides a powerful way to explore data dynamically based on the Templating variables selected on the Dashboard. |
||||
|
||||
Grafana allows you to reference queries in the Query Editor by the row that they’re on. If you add a second query to graph, you can reference the first query simply by typing in #A. This provides an easy and convenient way to build compounded queries. |
||||
|
||||
### ** Dashboard ** |
||||
|
||||
The Dashboard is where it all comes together. Dashboards can be thought of as of a set of one or more Panels organized and arranged into one or more Rows. |
||||
|
||||
The time period for the Dashboard can be controlled by the [Dashboard time picker](/reference/timerange/) in the upper right of the Dashboard. |
||||
|
||||
Dashboards can utilize [Templating](/reference/templating/) to make them more dynamic and interactive. |
||||
|
||||
Dashboards can utilize [Annotations](/reference/annotations/) to display event data across Panels. This can help correlate the time series data in the Panel with other events. |
||||
|
||||
Dashboards (or a specific Panel) can be [Shared](/reference/sharing/) easily in a variety of ways. You can send a link to someone who has a login to your Grafana. You can use the [Snapshot](/reference/sharing/#snapshots) feature to encode all the data currently being viewed into a static and interactive JSON document; it's so much better than emailing a screenshot! |
||||
|
||||
Dashboards can be tagged, and the Dashboard picker provides quick, searchable access to all Dashboards in a particular Organization. |
||||
@ -0,0 +1,32 @@ |
||||
page_title: Kayboard Shortcuts |
||||
page_description: Kayboard Shortcuts for Grafana |
||||
page_keywords: grafana, export, import, documentation |
||||
--- |
||||
|
||||
# Keyboard Shortcuts |
||||
|
||||
No mouse? No problem. Grafana has extensive keyboard shortcuts to allow you to navigate throughout the interface. This comes in especially handy when dealing with dealing with single-purpose machines powering on-wall displays that may not have a mouse available. |
||||
|
||||
## Dashboard Keyboard Shortcuts |
||||
|
||||
Press `Shift`+`?` to open the keyboard shortcut dialog from anywhere within the dashboard views. |
||||
|
||||
<img class="no-shadow" src="/img/v2/Grafana-Keyboard-Shortcuts.gif" style="width:80%;"> |
||||
|
||||
|
||||
|Shortcut|Action| |
||||
|---|---| |
||||
|`Esc`|Exit fullscreen edit/view mode, close search or any editor view| |
||||
|`CTRL`+`F`|Open dashboard search view (also contains import/playlist controls)| |
||||
|`CTRL`+`S`|Save dashboard| |
||||
|`CTRL`+`H`|Hide row controls| |
||||
|`CTRL`+`Z`|Zoom out| |
||||
|`CTRL`+`R`|Refresh (Fetches new data and rerenders panels)| |
||||
|`CTRL`+`O`|Enable/Disable shared graph crosshair| |
||||
|
||||
|
||||
|
||||
**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. |
||||
@ -1,34 +1,54 @@ |
||||
---- |
||||
page_title: Search guide |
||||
page_description: Search guide |
||||
page_keywords: grafana, time range, guide, documentation |
||||
page_title: Dashboard Search |
||||
page_description: Dashboard Search in Grafana |
||||
page_keywords: grafana, search, guide, documentation |
||||
--- |
||||
|
||||
# Search Guide |
||||
# Dashboard Search |
||||
|
||||
To search and load dashboards click the open folder icon in the header or use the shortcut CTRL+F. |
||||
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. |
||||
|
||||
## Tags |
||||
 |
||||
<img class="no-shadow" src="/img/v2/dashboard_search.png"> |
||||
|
||||
Click on any dashboard or use the down arrow key to navigate the search result and hit enter to open the selected dashboard. |
||||
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. |
||||
3. `Starred`: The starred link allows you to filter the list to display only starred dashboards. |
||||
4. `Tags`: The tags filter allows you to filter the list by dashboard tags. |
||||
|
||||
If you have a lot of dashboards use tags to organize them. You can add tags in the dashboards settings modal. |
||||
When using only a keyboard, you can use your keyboard arrow keys to navigate the results, hit enter to open the selected dashboard. |
||||
|
||||
 |
||||
## Find by dashboard name |
||||
|
||||
After you have added tags you can now view all available tags in the search popup. Click the tags link to the right in the search box, or just hit tab and then enter. You should now see a list of all tags. You can filter the tag list by continue writing in the search box, for example: "tags!:mongodb". |
||||
<img class="no-shadow" src="/img/v2/dashboard_search_text.gif"> |
||||
|
||||
 |
||||
To search and load dashboards click the open folder icon in the header or use the shortcut `CTRL`+`F`. Begin typing any part of the desired dashboard names. Search will return results for for any partial string match in real-time, as you type. |
||||
|
||||
Click on any tag in the tag list to show dashboards with that tag (or just down arrow key to select a tag then enter key). |
||||
Dashboard search is: |
||||
- Real-time |
||||
- *Not* case senstitive |
||||
- Functional across stored *and* file based dashboards. |
||||
|
||||
## Keyboard navigation |
||||
## Filter by Tag(s) |
||||
|
||||
While the search input has focus you can use your keyboard arrow keys to navigate the results, hit enter to open the selected dashboard. |
||||
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"> |
||||
|
||||
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"> |
||||
|
||||
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**. |
||||
|
||||
|
||||
## 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"> |
||||
|
||||
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. |
||||
Loading…
Reference in new issue