mirror of
https://github.com/grafana/grafana.git
synced 2025-02-09 23:16:16 -06:00
docs(): fixing image urls in docs
This commit is contained in:
Torkel Ödegaard
parent
3cc4a194a9
commit
2b81b204aa
@ -16,7 +16,7 @@ Grafana ships with built in support for CloudWatch. You just have to add it as a
|
||||
be ready to build dashboards for you CloudWatch metrics.
|
||||
|
||||
## Adding the data source
|
||||
|
||||
|
||||
|
||||
1. Open the side menu by clicking the the Grafana icon in the top header.
|
||||
2. In the side menu under the `Dashboards` link you should find a link named `Data Sources`.
|
||||
@ -60,7 +60,7 @@ Example content:
|
||||
|
||||
## Metric Query Editor
|
||||
|
||||
|
||||
|
||||
|
||||
You need to specify a namespace, metric, at least one stat, and at least one dimension.
|
||||
|
||||
@ -101,7 +101,7 @@ Example `ec2_instance_attribute()` query
|
||||
|
||||
ec2_instance_attribute(us-east-1, InstanceId, { "tag:Environment": [ "production" ] })
|
||||
|
||||
|
||||
|
||||
|
||||
## Cost
|
||||
|
||||
|
||||
@ -17,7 +17,7 @@ also annotate your graphs with log events stored in elasticsearch.
|
||||
|
||||
## Adding the data source
|
||||
|
||||
|
||||
|
||||
|
||||
1. Open the side menu by clicking the the Grafana icon in the top header.
|
||||
2. In the side menu under the `Dashboards` link you should find a link named `Data Sources`.
|
||||
@ -47,14 +47,14 @@ Elasticsearch from the browser. You do this by specifying these to options in yo
|
||||
|
||||
### Index settings
|
||||
|
||||
|
||||
|
||||
|
||||
Here you can specify a default for the `time field` and specify the name of your elasticsearch index. You can use
|
||||
a time pattern for the index name or a wildcard.
|
||||
|
||||
## Metric Query editor
|
||||
|
||||
|
||||
|
||||
|
||||
The Elasticsearch query editor allows you to select multiple metrics and group by multiple terms or filters. Use the plus and minus icons to the right to add / remove
|
||||
metrics or group bys. Some metrics and group by have options, click the option text to expand the the row to view and edit metric or group by options.
|
||||
@ -66,7 +66,7 @@ If you have Elasticsearch 2.x and Grafana 2.6 or above then you can use pipeline
|
||||
to hide metrics from appearing in the graph. This is useful for metrics you only have in the query to be used
|
||||
in a pipeline metric.
|
||||
|
||||
|
||||
|
||||
|
||||
## Templating
|
||||
|
||||
|
||||
@ -17,7 +17,7 @@ change function parameters and much more. The editor can handle all types of gra
|
||||
queries through the use of query references.
|
||||
|
||||
## Adding the data source
|
||||
|
||||
|
||||
|
||||
1. Open the side menu by clicking the the Grafana icon in the top header.
|
||||
2. In the side menu under the `Dashboards` link you should find a link named `Data Sources`.
|
||||
@ -46,7 +46,7 @@ Direct access is still supported because in some cases it may be useful to acces
|
||||
Click the ``Select metric`` link to start navigating the metric space. One you start you can continue using the mouse
|
||||
or keyboard arrow keys. You can select a wildcard and still continue.
|
||||
|
||||
|
||||
|
||||
|
||||
### Functions
|
||||
Click the plus icon to the right to add a function. You can search for the function or select it from the menu. Once
|
||||
@ -54,13 +54,13 @@ a function is selected it will be added and your focus will be in the text box o
|
||||
a parameter just click on it and it will turn into a text box. To delete a function click the function name followed
|
||||
by the x icon.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Optional parameters
|
||||
Some functions like aliasByNode support an optional second argument. To add this parameter specify for example 3,-2 as the first parameter and the function editor will adapt and move the -2 to a second parameter. To remove the second optional parameter just click on it and leave it blank and the editor will remove it.
|
||||
|
||||
|
||||
|
||||
|
||||
## Point consolidation
|
||||
|
||||
@ -80,7 +80,7 @@ values that exists in the wildcard position.
|
||||
You can also create nested variables that use other variables in their definition. For example
|
||||
`apps.$app.servers.*` uses the variable `$app` in its query definition.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Query Reference
|
||||
|
||||
@ -14,7 +14,7 @@ weight = 3
|
||||
Grafana ships with very a feature data source plugin for InfluxDB. Supporting a feature rich query editor, annotation and templating queries.
|
||||
|
||||
## Adding the data source
|
||||
|
||||
|
||||
|
||||
1. Open the side menu by clicking the the Grafana icon in the top header.
|
||||
2. In the side menu under the `Dashboards` link you should find a link named `Data Sources`.
|
||||
@ -41,7 +41,7 @@ Password | Database user's password
|
||||
|
||||
## Query Editor
|
||||
|
||||
|
||||
|
||||
|
||||
You find the InfluxDB editor in the metrics tab in Graph or Singlestat panel's edit mode. You enter edit mode by clicking the
|
||||
panel title, then edit. The editor allows you to select metrics and tags.
|
||||
@ -60,7 +60,7 @@ In the `SELECT` row you can specify what fields and functions you want to use. I
|
||||
group by time you need an aggregation function. Some functions like derivative require an aggregation function.
|
||||
|
||||
The editor tries simplify and unify this part of the query. For example:
|
||||
|
||||
|
||||
|
||||
The above will generate the following InfluxDB `SELECT` clause:
|
||||
|
||||
@ -93,7 +93,7 @@ You can switch to raw query mode by clicking hamburger icon and then `Switch edi
|
||||
|
||||
### Table query / raw data
|
||||
|
||||
|
||||
|
||||
|
||||
You can remove the group by time by clicking on the `time` part and then the `x` icon. You can
|
||||
change the option `Format As` to `Table` if you want to show raw data in the `Table` panel.
|
||||
|
||||
@ -8,7 +8,7 @@ page_keywords: grafana, kairosdb, documentation
|
||||
Grafana v2.1 brings initial support for KairosDB Datasources. While the process of adding the datasource is similar to adding a Graphite or OpenTSDB datasource type, Kairos DB does have a few different options for building queries.
|
||||
|
||||
## Adding the data source to Grafana
|
||||
|
||||
|
||||
|
||||
1. Open the side menu by clicking the the Grafana icon in the top header.
|
||||
2. In the side menu under the `Dashboards` link you should find a link named `Data Sources`.
|
||||
@ -30,7 +30,7 @@ Access | Proxy = access via Grafana backend, Direct = access directly from brows
|
||||
## Query editor
|
||||
Open a graph in edit mode by click the title.
|
||||
|
||||
|
||||
|
||||
|
||||
For details on KairosDB metric queries checkout the official.
|
||||
- [Query Metrics - KairosDB 0.9.4 documentation](http://kairosdb.github.io/kairosdocs/restapi/QueryMetrics.html).
|
||||
|
||||
@ -11,7 +11,7 @@ weight = 5
|
||||
|
||||
# Using OpenTSDB in Grafana
|
||||
|
||||
{{< docs-imagebox img="img/docs/v2/add_OpenTSDB.png" max-width="14rem" >}}
|
||||
{{< docs-imagebox img="/img/docs/v2/add_OpenTSDB.png" max-width="14rem" >}}
|
||||
|
||||
The newest release of Grafana adds additional functionality when using an OpenTSDB Data source.
|
||||
|
||||
@ -37,7 +37,7 @@ Open a graph in edit mode by click the title. Query editor will differ if the da
|
||||
|
||||
> Note: While using Opentsdb 2.2 datasource, make sure you use either Filters or Tags as they are mutually exclusive. If used together, might give you weird results.
|
||||
|
||||
|
||||
|
||||
|
||||
### Auto complete suggestions
|
||||
As soon as you start typing metric names, tag names and tag values , you should see highlighted auto complete suggestions for them.
|
||||
|
||||
@ -15,7 +15,7 @@ weight = 2
|
||||
Grafana includes support for Prometheus Datasources. While the process of adding the datasource is similar to adding a Graphite or OpenTSDB datasource type, Prometheus does have a few different options for building queries.
|
||||
|
||||
## Adding the data source to Grafana
|
||||
|
||||
|
||||
|
||||
1. Open the side menu by clicking the the Grafana icon in the top header.
|
||||
2. In the side menu under the `Dashboards` link you should find a link named `Data Sources`.
|
||||
@ -42,7 +42,7 @@ Password | Database user's password
|
||||
## Query editor
|
||||
Open a graph in edit mode by click the title.
|
||||
|
||||
|
||||
|
||||
|
||||
For details on Prometheus metric queries check out the Prometheus documentation
|
||||
- [Query Metrics - Prometheus documentation](http://prometheus.io/docs/querying/basics/).
|
||||
@ -72,4 +72,4 @@ label_values(hostname)
|
||||
|
||||
You can also use raw queries & regular expressions to extract anything you might need.
|
||||
|
||||
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ Read the [Basic Concepts](/guides/basic_concepts) document to get a crash course
|
||||
|
||||
Let's start with creating a new Dashboard. You can find the new Dashboard link at the bottom of the Dashboard picker. You now have a blank Dashboard.
|
||||
|
||||
<img class="no-shadow" src="img/docs/v2/v2_top_nav_annotated.png">
|
||||
<img class="no-shadow" src="/img/docs/v2/v2_top_nav_annotated.png">
|
||||
|
||||
The image above shows you the top header for a Dashboard.
|
||||
|
||||
@ -39,7 +39,7 @@ Dashboards are at the core of what Grafana is all about. Dashboards are composed
|
||||
|
||||
## Adding & Editing Graphs and Panels
|
||||
|
||||
|
||||
|
||||
|
||||
1. You add panels via row menu. The row menu is the green icon to the left of each row.
|
||||
2. To edit the graph you click on the graph title to open the panel menu, then `Edit`.
|
||||
@ -48,7 +48,7 @@ Dashboards are at the core of what Grafana is all about. Dashboards are composed
|
||||
When you click the `Metrics` tab, you are presented with a Query Editor that is specific to the Panel Data Source. Use the Query Editor to build your queries and Grafana will visualize them in real time.
|
||||
|
||||
|
||||
<img src="img/docs/v2/dashboard_annotated.png" class="no-shadow">
|
||||
<img src="/img/docs/v2/dashboard_annotated.png" class="no-shadow">
|
||||
|
||||
1. Zoom out time range
|
||||
2. Time picker dropdown. Here you can access relative time range options, auto refresh options and set custom absolute time ranges.
|
||||
@ -61,7 +61,7 @@ When you click the `Metrics` tab, you are presented with a Query Editor that is
|
||||
|
||||
You can Drag-and-Drop Panels within and between Rows. Click and hold the Panel title, and drag it to its new location. You can also easily resize panels by clicking the (-) and (+) icons.
|
||||
|
||||
|
||||
|
||||
|
||||
## Tips and shortcuts
|
||||
|
||||
@ -79,15 +79,3 @@ You can Drag-and-Drop Panels within and between Rows. Click and hold the Panel t
|
||||
* Ctrl+H Hides all controls (good for tv displays)
|
||||
* Hit Escape to exit graph when in fullscreen or edit mode
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -23,7 +23,7 @@ A template variable with Multi-Value enabled allows for the selection of multipl
|
||||
These variables can then be used in any Panel to make them more dynamic, and to give you the perfect view of your data.
|
||||
Multi-Value variables is also enabling the new `row repeat` and `panel repeat` feature described below.
|
||||
|
||||
|
||||
|
||||
<br/><br/>
|
||||
|
||||
### Repeating Rows and Panels
|
||||
@ -31,7 +31,7 @@ It’s now possible to create a dashboard that automatically adds (or removes) b
|
||||
on selected variable values. Any row or any panel can be configured to repeat (duplicate itself) based
|
||||
on a multi-value template variable.</p>
|
||||
|
||||
|
||||
|
||||
<br/><br/>
|
||||
|
||||
### Dashboard Links & Navigation
|
||||
@ -39,7 +39,7 @@ To support better navigation between dashboards, it's now possible to create cus
|
||||
panels to appropriate Dashboards. You also have the ability to create flexible top-level links on any
|
||||
given dashboard thanks to the new dashboard navigation bar feature.
|
||||
|
||||
|
||||
|
||||
|
||||
Dashboard links can be added under dashboard settings. Either defined as static URLs with a custom icon or as dynamic
|
||||
dashboard links or dropdowns based on custom dashboard search query. These links appear in the same
|
||||
@ -88,7 +88,7 @@ The Viewer role has been modified in Grafana 2.1 so that users assigned this rol
|
||||
Grafana 2.1 now comes with full support for InfluxDB 0.9. There is a new query editor designed from scratch
|
||||
for the new features InfluxDB 0.9 enables.
|
||||
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
@ -116,15 +116,15 @@ Define series color using regex rule. This is useful when you have templated gra
|
||||
that change depending selected template variables. Using a regex style override rule you could
|
||||
for example make all series that contain the word **CPU** `red` and assigned to the second y axis.
|
||||
|
||||
|
||||
|
||||
|
||||
New series style override, negative-y transform and stack groups. Negative y transform is
|
||||
very useful if you want to plot a series on the negative y scale without affecting the legend values like min or max or
|
||||
the values shown in the hover tooltip.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Singlestat Panel
|
||||
Now support string values. Useful for time series database like InfluxDB that supports
|
||||
|
||||
@ -18,7 +18,7 @@ fixes and enhancements to all areas of Grafana, like new Data Sources, a new and
|
||||
resize handles and improved InfluxDB and OpenTSDB support.
|
||||
|
||||
### New time range controls
|
||||
<img src="img/docs/whatsnew_2_5/timepicker.png" alt="New Time picker">
|
||||
<img src="/img/docs/whatsnew_2_5/timepicker.png" alt="New Time picker">
|
||||
|
||||
A new timepicker with room for more quick ranges as well as new types of relative ranges, like `Today`,
|
||||
`The day so far` and `This day last week`. Also an improved time & calendar picker that now works
|
||||
@ -26,7 +26,7 @@ correctly in UTC mode.
|
||||
|
||||
### Elasticsearch
|
||||
|
||||
<img src="img/docs/whatsnew_2_5/elasticsearch_metrics_ex1.png" alt="Elasticsearch example">
|
||||
<img src="/img/docs/whatsnew_2_5/elasticsearch_metrics_ex1.png" alt="Elasticsearch example">
|
||||
<br>
|
||||
|
||||
This release brings a fully featured query editor for Elasticsearch. You will now be able to visualize
|
||||
@ -46,7 +46,7 @@ Try the new Elasticsearch query editor on the [play.grafana.org](http://play.gra
|
||||
|
||||
### CloudWatch
|
||||
|
||||
<img src="img/docs/whatsnew_2_5/cloudwatch.png" alt="Cloudwatch editor">
|
||||
<img src="/img/docs/whatsnew_2_5/cloudwatch.png" alt="Cloudwatch editor">
|
||||
|
||||
Grafana 2.5 ships with a new CloudWatch datasource that will allow you to query and visualize CloudWatch
|
||||
metrics directly from Grafana.
|
||||
@ -57,14 +57,14 @@ metrics directly from Grafana.
|
||||
|
||||
### Prometheus
|
||||
|
||||
<img src="img/docs/whatsnew_2_5/prometheus_editor.png" alt="Prometheus editor">
|
||||
<img src="/img/docs/whatsnew_2_5/prometheus_editor.png" alt="Prometheus editor">
|
||||
|
||||
Grafana 2.5 ships with a new Prometheus datasource that will allow you to query and visualize data
|
||||
stored in Prometheus.
|
||||
|
||||
|
||||
### Mix different data sources
|
||||
<img src="img/docs/whatsnew_2_5/mixed_data.png" alt="Mix data sources in the same dashboard or in the same graph!">
|
||||
<img src="/img/docs/whatsnew_2_5/mixed_data.png" alt="Mix data sources in the same dashboard or in the same graph!">
|
||||
|
||||
In previous releases you have been able to mix different data sources on the same dashboard. In v2.5 you
|
||||
will be able to mix then on the same graph! You can enable this by selecting the built in `-- Mixed --` data source.
|
||||
@ -73,12 +73,12 @@ to plot metrics from different Graphite servers on the same Graph or plot data f
|
||||
data from Prometheus. Mixing different data sources on the same graph works for any data source, even custom ones.
|
||||
|
||||
### Panel Resize handles
|
||||
<img src="img/docs/whatsnew_2_5/panel_resize.gif" alt="">
|
||||
<img src="/img/docs/whatsnew_2_5/panel_resize.gif" alt="">
|
||||
|
||||
This release adds resize handles to the the bottom right corners of panels making is easy to resize both width and height.
|
||||
|
||||
### User invites
|
||||
<img src="img/docs/whatsnew_2_5/org_invite.png" alt="">
|
||||
<img src="/img/docs/whatsnew_2_5/org_invite.png" alt="">
|
||||
|
||||
This version also brings some new features for user management.
|
||||
|
||||
|
||||
@ -17,7 +17,7 @@ The release includes a new Table panel, a new InfluxDB query editor, support for
|
||||
support for multiple Cloudwatch credentials.
|
||||
|
||||
## Table Panel
|
||||
<img src="assets/img/features/table-panel.png">
|
||||
<img src="/assets/img/features/table-panel.png">
|
||||
|
||||
The new table panel is very flexible, supporting both multiple modes for time series as well as for
|
||||
table, annotation and raw JSON data. It also provides date formating and value formating and coloring options.
|
||||
@ -27,7 +27,7 @@ table, annotation and raw JSON data. It also provides date formating and value f
|
||||
In the most simple mode you can turn time series to rows. This means you get a `Time`, `Metric` and a `Value` column.
|
||||
Where `Metric` is the name of the time series.
|
||||
|
||||
<img src="img/docs/v2/table_ts_to_rows.png">
|
||||
<img src="/img/docs/v2/table_ts_to_rows.png">
|
||||
|
||||
### Table Transform
|
||||
Above you see the options tab for the **Table Panel**. The most important option is the `To Table Transform`.
|
||||
@ -40,7 +40,7 @@ The column styles allow you control how dates and numbers are formatted.
|
||||
This transform allows you to take multiple time series and group them by time. Which will result in a `Time` column
|
||||
and a column for each time series.
|
||||
|
||||
<img src="img/docs/v2/table_ts_to_columns.png">
|
||||
<img src="/img/docs/v2/table_ts_to_columns.png">
|
||||
|
||||
In the screenshot above you can see how the same time series query as in the previous example can be transformed into
|
||||
a different table by changing the `To Table Transform` to `Time series to columns`.
|
||||
@ -49,7 +49,7 @@ a different table by changing the `To Table Transform` to `Time series to colum
|
||||
This transform works very similar to the legend values in the Graph panel. Each series gets its own row. In the Options
|
||||
tab you can select which aggregations you want using the plus button the Columns section.
|
||||
|
||||
<img src="img/docs/v2/table_ts_to_aggregations.png">
|
||||
<img src="/img/docs/v2/table_ts_to_aggregations.png">
|
||||
|
||||
You have to think about how accurate the aggregations will be. It depends on what aggregation is used in the time series query,
|
||||
how many data points are fetched, etc. The time series aggregations are calculated by Grafana after aggregation is performed
|
||||
@ -59,39 +59,39 @@ by the time series database.
|
||||
|
||||
If you want to show documents from Elasticsearch pick `Raw Document` as the first metric.
|
||||
|
||||
<img src="img/docs/v2/elastic_raw_doc.png">
|
||||
<img src="/img/docs/v2/elastic_raw_doc.png">
|
||||
|
||||
This in combination with the `JSON Data` table transform will allow you to pick which fields in the document
|
||||
you want to show in the table.
|
||||
|
||||
<img src="img/docs/v2/table_json_data.png">
|
||||
<img src="/img/docs/v2/table_json_data.png">
|
||||
|
||||
### Elasticsearch aggregations
|
||||
|
||||
You can also make Elasticsearch aggregation queries without a `Date Histogram`. This allows you to
|
||||
use Elasticsearch metric aggregations to get accurate aggregations for the selected time range.
|
||||
|
||||
<img src="img/docs/v2/elastic_aggregations.png">
|
||||
<img src="/img/docs/v2/elastic_aggregations.png">
|
||||
|
||||
### Annotations
|
||||
|
||||
The table can also show any annotations you have enabled in the dashboard.
|
||||
|
||||
<img src="img/docs/v2/table_annotations.png">
|
||||
<img src="/img/docs/v2/table_annotations.png">
|
||||
|
||||
## The New InfluxDB Editor
|
||||
The new InfluxDB editor is a lot more flexible and powerful. It supports nested functions, like `derivative`.
|
||||
It also uses the same technique as the Graphite query editor in that it presents nested functions as chain of function
|
||||
transformations. It tries to simplify and unify the complicated nature of InfluxDB's query language.
|
||||
|
||||
<img src="assets/img/blog/v2.6/influxdb_editor_v3.gif">
|
||||
<img src="/assets/img/blog/v2.6/influxdb_editor_v3.gif">
|
||||
|
||||
In the `SELECT` row you can specify what fields and functions you want to use. If you have a
|
||||
group by time you need an aggregation function. Some functions like derivative require an aggregation function.
|
||||
|
||||
The editor tries simplify and unify this part of the query. For example:
|
||||
|
||||
|
||||
|
||||
|
||||
The above will generate the following InfluxDB `SELECT` clause:
|
||||
|
||||
@ -110,7 +110,7 @@ You can remove the group by by clicking on the `tag` and then click on the x ico
|
||||
The new editor also allows you to remove group by time and select `raw` table data. Which is very useful
|
||||
in combination with the new Table panel to show raw log data stored in InfluxDB.
|
||||
|
||||
<img src="assets/img/blog/v2.6/table_influxdb_logs.png">
|
||||
<img src="/assets/img/blog/v2.6/table_influxdb_logs.png">
|
||||
|
||||
## Pipeline metrics
|
||||
|
||||
|
||||
@ -55,7 +55,7 @@ even zoom in). Also they are fast to load as they aren't actually connected to a
|
||||
|
||||
They're a great way to communicate about a particular incident with specific people who aren't Users of your Grafana instance. You can also use them to show off your dashboards over the Internet.
|
||||
|
||||
|
||||
|
||||
|
||||
### Publish snapshots
|
||||
|
||||
@ -67,11 +67,11 @@ Either way, anyone with the link (and access to your Grafana instance for local
|
||||
|
||||
In Grafana v2.x you can now override the relative time range for individual panels, causing them to be different than what is selected in the Dashboard time picker in the upper right. You can also add a time shift to individual panels. This allows you to show metrics from different time periods or days at the same time.
|
||||
|
||||
|
||||
|
||||
|
||||
You control these overrides in panel editor mode and the new tab `Time Range`.
|
||||
|
||||
|
||||
|
||||
|
||||
When you zoom or change the Dashboard time to a custom absolute time range, all panel overrides will be disabled. The panel relative time override is only active when the dashboard time is also relative. The panel timeshift override however is always active, even when the dashboard time is absolute.
|
||||
|
||||
@ -96,7 +96,7 @@ This feature makes it easy to include interactive visualizations from your Grafa
|
||||
|
||||
The top header has gotten a major streamlining in Grafana V2.0.
|
||||
|
||||
<img class="no-shadow" src="img/docs/v2/v2_top_nav_annotated.png">
|
||||
<img class="no-shadow" src="/img/docs/v2/v2_top_nav_annotated.png">
|
||||
|
||||
1. `Side menubar toggle` Toggle the side menubar on or off. This allows you to focus on the data presented on the Dashboard. The side menubar provides access to features unrelated to a Dashboard such as Users, Organizations, and Data Sources.
|
||||
2. `Dashboard dropdown` The main dropdown shows you which Dashboard you are currently viewing, and allows you to easily switch to a new Dashboard. From here you can also create a new Dashboard, Import existing Dashboards, and manage the Playlist.
|
||||
@ -121,7 +121,7 @@ You can easily collapse or re-open the side menubar at any time by clicking the
|
||||
|
||||
## New search view & starring dashboards
|
||||
|
||||
|
||||
|
||||
|
||||
The dashboard search view has gotten a big overhaul. You can now see and filter by which dashboard you have personally starred.
|
||||
|
||||
@ -130,11 +130,11 @@ The dashboard search view has gotten a big overhaul. You can now see and filter
|
||||
The Graph panel now supports 3 logarithmic scales, `log base 10`, `log base 32`, `log base 1024`. Logarithmic y-axis scales are very useful when rendering many series of different order of magnitude on the same scale (eg.
|
||||
latency, network traffic, and storage)
|
||||
|
||||
|
||||
|
||||
|
||||
## Dashlist panel
|
||||
|
||||
|
||||
|
||||
|
||||
The dashlist is a new panel in Grafana v2.0. It allows you to show your personal starred dashboards, as well as do custom searches based on search strings or tags.
|
||||
|
||||
@ -153,7 +153,7 @@ In addition, connections to Data Sources can be better controlled and secured, a
|
||||
A commonly reported problem has been graphs dipping to zero at the the end, because metric data for the last interval has yet to be written to the Data Source. These graphs then "self correct" once the data comes in, but can look deceiving or alarming at times.
|
||||
|
||||
You can avoid this problem by adding a `now delay` in `Dashboard Settings` > `Time Picker` tab. This new feature will cause Grafana to ignore the most recent data up to the set delay.
|
||||
|
||||
|
||||
|
||||
The delay that may be necessary depends on how much latency you have in your collection pipeline.
|
||||
|
||||
@ -161,7 +161,7 @@ The delay that may be necessary depends on how much latency you have in your col
|
||||
|
||||
Grafana v2.0 protects Users from accidentally overwriting each others Dashboard changes. Similar protections are in place if you try to create a new Dashboard with the same name as an existing one.
|
||||
|
||||
|
||||
|
||||
|
||||
These protections are only the first step; we will be building out additional capabilities around dashboard versioning and management in future versions of Grafana.
|
||||
|
||||
@ -177,6 +177,6 @@ Grafana now supports server-side PNG rendering. From the Panel share dialog you
|
||||
|
||||
> **Note** This requires that your Data Source is accessible from your Grafana instance.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -16,21 +16,21 @@ weight = 1
|
||||
|
||||
The export feature is now accessed from the share menu.
|
||||
|
||||
<img src="img/docs/v31/export_menu.png">
|
||||
<img src="/img/docs/v31/export_menu.png">
|
||||
|
||||
Dashboards exported from Grafana 3.1 are now more portable and easier for others to import than before.
|
||||
The export process extracts information data source types used by panels and adds these to a new `inputs`
|
||||
section in the dashboard json. So when you or another person tries to import the dashboard they will be asked to
|
||||
select data source and optional metrix prefix options.
|
||||
|
||||
<img src="img/docs/v31/import_step1.png">
|
||||
<img src="/img/docs/v31/import_step1.png">
|
||||
|
||||
The above screenshot shows the new import modal that gives you 3 options for how to import a dashboard.
|
||||
One notable new addition here is the ability to import directly from Dashboards shared on [Grafana.net](https://grafana.net).
|
||||
|
||||
The next step in the import process:
|
||||
|
||||
<img src="img/docs/v31/import_step2.png">
|
||||
<img src="/img/docs/v31/import_step2.png">
|
||||
|
||||
Here you can change the name of the dashboard and also pick what data sources you want the dashboard to use. The above screenshot
|
||||
shows a CollectD dashboard for Graphite that requires a metric prefix be specified.
|
||||
@ -41,7 +41,7 @@ On [Grafana.net](https://grafana.net) you can now browse & search for dashboards
|
||||
more are being uploaded every day. To import a dashboard just copy the dashboard url and head back to Grafana,
|
||||
then Dashboard Search -> Import -> Paste Grafana.net Dashboard URL.
|
||||
|
||||
<img src="img/docs/v31/gnet_dashboards_list.png">
|
||||
<img src="/img/docs/v31/gnet_dashboards_list.png">
|
||||
|
||||
## Constant template variables
|
||||
|
||||
|
||||
@ -43,7 +43,7 @@ entire experience right within Grafana.
|
||||
|
||||
## Grafana.net
|
||||
|
||||
<img src="img/docs/v3/grafana_net_tour.png">
|
||||
<img src="/img/docs/v3/grafana_net_tour.png">
|
||||
|
||||
[Grafana.net](https://grafana.net) offers a central repository where the community can come together to discover, create and
|
||||
share plugins (data sources, panels, apps) and dashboards.
|
||||
@ -102,7 +102,7 @@ periodically and remotely.
|
||||
You can also make Playlists dynamic by using Dashboard **tags** to
|
||||
define the Playlist.
|
||||
|
||||
<img src="img/docs/v3/playlist.png">
|
||||
<img src="/img/docs/v3/playlist.png">
|
||||
|
||||
## Improved UI
|
||||
|
||||
@ -122,11 +122,11 @@ are literally hundreds of UI improvements and refinements.
|
||||
|
||||
Here’s the new side menu in action:
|
||||
|
||||
<img src="img/docs/v3/menu.gif">
|
||||
<img src="/img/docs/v3/menu.gif">
|
||||
|
||||
And here's the new look for Dashboard settings:
|
||||
|
||||
<img src="img/docs/v3/dashboard_settings.png">
|
||||
<img src="/img/docs/v3/dashboard_settings.png">
|
||||
|
||||
Check out the <a href="http://play.grafana.org" target="_blank">Play
|
||||
Site</a> to get a feel for some of the UI changes.
|
||||
@ -138,7 +138,7 @@ over the link and click the annotation text. This feature is very
|
||||
useful for linking to particular commits or tickets where more
|
||||
detailed information can be presented to the user.
|
||||
|
||||
<img src="img/docs/v3/annotation_links.gif">
|
||||
<img src="/img/docs/v3/annotation_links.gif">
|
||||
|
||||
## Data source variables
|
||||
|
||||
@ -146,11 +146,11 @@ This has been a top requested feature for very long we are exited to finally pro
|
||||
this feature. You can now add a new `Data source` type variable. That will
|
||||
automatically be filled with instance names of your data sources.
|
||||
|
||||
<img src="img/docs/v3/data_source_variable.png">
|
||||
<img src="/img/docs/v3/data_source_variable.png">
|
||||
|
||||
You can then use this variable as the panel data source:
|
||||
|
||||
<img src="img/docs/v3/data_source_variable_use.png">
|
||||
<img src="/img/docs/v3/data_source_variable_use.png">
|
||||
|
||||
This will allow you to quickly change data source server and reuse the
|
||||
same dashboard for different instances of your metrics backend. For example
|
||||
@ -168,7 +168,7 @@ The Prometheus Data Source now supports annotations.
|
||||
### InfluxDB
|
||||
|
||||
You can now select the InfluxDB policy from the query editor.
|
||||
<img src="img/docs/v3/influxdb_policy.png">
|
||||
<img src="/img/docs/v3/influxdb_policy.png">
|
||||
|
||||
Grafana 3.0 also comes with support for InfluxDB 0.11 and InfluxDB 0.12.
|
||||
|
||||
@ -201,23 +201,23 @@ are a couple that I incurage you try!
|
||||
|
||||
#### [Clock Panel](https://grafana.net/plugins/grafana-clock-panel)
|
||||
Support's both current time and count down mode.
|
||||
<img src="img/docs/v3/clock_panel.png">
|
||||
<img src="/img/docs/v3/clock_panel.png">
|
||||
|
||||
#### [Pie Chart Panel](https://grafana.net/plugins/grafana-piechart-panel)
|
||||
A simple pie chart panel is now available as an external plugin.
|
||||
<img src="img/docs/v3/pie_chart_panel.png">
|
||||
<img src="/img/docs/v3/pie_chart_panel.png">
|
||||
|
||||
#### [WorldPing App](https://grafana.net/plugins/raintank-worldping-app)
|
||||
This is full blown Grafana App that adds new panels, data sources and pages to give
|
||||
feature rich global performance monitoring directly from your on-prem Grafana.
|
||||
|
||||
<img src="img/docs/v3/wP-Screenshot-dash-web.png">
|
||||
<img src="/img/docs/v3/wP-Screenshot-dash-web.png">
|
||||
|
||||
#### [Zabbix App](https://grafana.net/plugins/alexanderzobnin-zabbix-app)
|
||||
This app contains the already very pouplar Zabbix data source plugin, 2 dashboards and a triggers panel. It is
|
||||
created and maintained by [Alexander Zobnin](https://github.com/alexanderzobnin/grafana-zabbix).
|
||||
|
||||
<img src="img/docs/v3/zabbix_app.png">
|
||||
<img src="/img/docs/v3/zabbix_app.png">
|
||||
|
||||
Checkout the full list of plugins on [Grafana.net](https://grafana.net/plugins)
|
||||
|
||||
|
||||
@ -25,7 +25,7 @@ curl example:
|
||||
|
||||
Open the sidemenu and click the organization dropdown and select the `API Keys` option.
|
||||
|
||||
|
||||
|
||||
|
||||
You use the token in all requests in the `Authorization` header, like this:
|
||||
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
+++
|
||||
title = "Grafana Installation"
|
||||
title = "Grafana Documentation Site"
|
||||
description = "Install guide for Grafana"
|
||||
keywords = ["grafana", "installation", "documentation"]
|
||||
type = "docs_root"
|
||||
type = "docs"
|
||||
[menu.docs]
|
||||
name = "Welcome to the Docs"
|
||||
identifier = "root"
|
||||
|
||||
@ -61,7 +61,7 @@ sure your Elasticsearch data source is added. Specify the Elasticsearch
|
||||
index name where your existing Grafana v1.x dashboards are stored
|
||||
(the default is `grafana-dash`).
|
||||
|
||||
|
||||
|
||||
|
||||
### Importing dashboards from InfluxDB
|
||||
|
||||
@ -74,7 +74,7 @@ your Grafana v1.x dashboards are stored, the default is `grafana`.
|
||||
Go to the `Dashboards` view and click on the dashboards search drop
|
||||
down. Click the `Import` button at the bottom of the search drop down.
|
||||
|
||||
|
||||
|
||||
|
||||
### Import view
|
||||
|
||||
@ -82,7 +82,7 @@ In the Import view you find the section `Migrate dashboards`. Pick the
|
||||
data source you added (from Elasticsearch or InfluxDB), and click the
|
||||
`Import` button.
|
||||
|
||||
|
||||
|
||||
|
||||
Your dashboards should be automatically imported into the Grafana 2.0
|
||||
back-end.
|
||||
|
||||
@ -23,7 +23,7 @@ with Grafana being unable to query Graphite, OpenTSDB or InfluxDB. You
|
||||
might not be able to get metric name completion or the graph might show
|
||||
an error like this:
|
||||
|
||||
|
||||
|
||||
|
||||
For some types of errors, the `View details` link will show you error
|
||||
details. For many types of HTTP connection errors, however, there is very
|
||||
@ -31,7 +31,7 @@ little information. The best way to troubleshoot these issues is use
|
||||
the [Chrome developer tools](https://developer.chrome.com/devtools/index).
|
||||
By pressing `F12` you can bring up the chrome dev tools.
|
||||
|
||||
|
||||
|
||||
|
||||
There are two important tabs in the Chrome developer tools: `Network`
|
||||
and `Console`. The `Console` tab will show you Javascript errors and
|
||||
@ -49,7 +49,7 @@ chrome console error, request and response information from the
|
||||
|
||||
### Inspecting Grafana metric requests
|
||||
|
||||
|
||||
|
||||
|
||||
After opening the Chrome developer tools for the first time the
|
||||
`Network` tab is empty. You will need to refresh the page to get
|
||||
|
||||
@ -11,7 +11,7 @@ App plugins is a new kind of grafana plugin that can bundle datasource and panel
|
||||
|
||||
Datasource and panel plugins will show up like normal plugins. The app pages will be available in the main menu.
|
||||
|
||||
<img class="no-shadow" src="img/v3/app-in-main-menu.png">
|
||||
<img class="no-shadow" src="/img/v3/app-in-main-menu.png">
|
||||
|
||||
## Enabling app plugins
|
||||
After installing an app it have to be enabled before it show up as an datasource or panel. You can do that on the app page in the config tab.
|
||||
|
||||
@ -13,7 +13,7 @@ weight = 2
|
||||
Annotations provide a way to mark points on the graph with rich events. When you hover over an annotation
|
||||
you can get title, tags, and text information for the event.
|
||||
|
||||
|
||||
|
||||
|
||||
To add an annotation query click dashboard settings icon in top menu and select `Annotations` from the
|
||||
dropdown. This will open the `Annotations` edit view. Click the `Add` tab to add a new annotation query.
|
||||
@ -28,7 +28,7 @@ Graphite supports two ways to query annotations.
|
||||
- Graphite events query, use the `Graphite event tags` text input, specify an tag or wildcard (leave empty should also work)
|
||||
|
||||
## Elasticsearch annotations
|
||||
|
||||
|
||||
|
||||
Grafana can query any Elasticsearch index for annotation events. The index name can be the name of an alias or an index wildcard pattern.
|
||||
You can leave the search query blank or specify a lucene query.
|
||||
@ -39,14 +39,14 @@ as the name for the fields that should be used for the annotation title, tags an
|
||||
> **Note** The annotation timestamp field in elasticsearch need to be in UTC format.
|
||||
|
||||
## InfluxDB Annotations
|
||||
|
||||
|
||||
|
||||
For InfluxDB you need to enter a query like in the above screenshot. You need to have the ```where $timeFilter``` part.
|
||||
If you only select one column you will not need to enter anything in the column mapping fields.
|
||||
|
||||
## Prometheus Annotations
|
||||
|
||||
|
||||
|
||||
|
||||
Prometheus supports two ways to query annotations.
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ weight = 4
|
||||
|
||||
The dashboard list panel allows you to display dynamic links to other dashboards. The list can be configured to use starred dashboards, a search query and/or dashboard tags.
|
||||
|
||||
<img class="no-shadow" src="img/docs/v2/dashboard_list_panels.png">
|
||||
<img class="no-shadow" src="/img/docs/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.
|
||||
|
||||
@ -21,7 +21,7 @@ The dashboard list panel allows you to display dynamic links to other 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/docs/v2/dashboard_list_config_starred.png">
|
||||
<img class="no-shadow" src="/img/docs/v2/dashboard_list_config_starred.png">
|
||||
|
||||
|
||||
## Mode: Search Dashboards
|
||||
@ -42,11 +42,11 @@ 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 case-insensitive, and partial values are accepted.
|
||||
<img class="no-shadow" src="img/docs/v2/dashboard_list_config_string.png">
|
||||
<img class="no-shadow" src="/img/docs/v2/dashboard_list_config_string.png">
|
||||
|
||||
### 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/docs/v2/dashboard_list_config_tags.png">
|
||||
<img class="no-shadow" src="/img/docs/v2/dashboard_list_config_tags.png">
|
||||
|
||||
> When multiple tags and strings appear, the dashboard list will display those matching ALL conditions.
|
||||
|
||||
|
||||
@ -17,7 +17,7 @@ Dashboards are exported in Grafana JSON format, and contain everything you need
|
||||
|
||||
The export feature is accessed from the share menu.
|
||||
|
||||
<img src="img/docs/v31/export_menu.png">
|
||||
<img src="/img/docs/v31/export_menu.png">
|
||||
|
||||
### Making a dashboard portable
|
||||
|
||||
@ -31,12 +31,12 @@ the dashboard, and will also be added as an required input when the dashboard is
|
||||
|
||||
To import a dashboard open dashboard search and then hit the import button.
|
||||
|
||||
<img src="img/docs/v31/import_step1.png">
|
||||
<img src="/img/docs/v31/import_step1.png">
|
||||
|
||||
From here you can upload a dashboard json file, paste a [Grafana.net](https://grafana.net) dashboard
|
||||
url or paste dashboard json text directly into the text area.
|
||||
|
||||
<img src="img/docs/v31/import_step2.png">
|
||||
<img src="/img/docs/v31/import_step2.png">
|
||||
|
||||
In step 2 of the import process Grafana will let you change the name of the dashboard, pick what
|
||||
data source you want the dashboard to use and specify any metric prefixes (if the dashboard use any).
|
||||
@ -45,7 +45,7 @@ data source you want the dashboard to use and specify any metric prefixes (if th
|
||||
|
||||
Find dashboads for common server applications at [Grafana.net/dashboards](https://grafana.net/dashboards).
|
||||
|
||||
<img src="img/docs/v31/gnet_dashboards_list.png">
|
||||
<img src="/img/docs/v31/gnet_dashboards_list.png">
|
||||
|
||||
## Import & Sharing with Grafana 2.x or 3.0
|
||||
|
||||
|
||||
@ -12,13 +12,13 @@ weight = 1
|
||||
|
||||
The main panel in Grafana is simply named Graph. It provides a very rich set of graphing options.
|
||||
|
||||
<img src="img/docs/v1/graph_overview.png" class="no-shadow">
|
||||
<img src="/img/docs/v1/graph_overview.png" class="no-shadow">
|
||||
|
||||
Clicking the title for a panel exposes a menu. The `edit` option opens additional configuration
|
||||
options for the panel.
|
||||
|
||||
## General
|
||||
|
||||
|
||||
|
||||
The general tab allows customization of a panel's appearance and menu options.
|
||||
|
||||
@ -56,7 +56,7 @@ options.
|
||||
|
||||
## Axes & Grid
|
||||
|
||||
|
||||
|
||||
|
||||
The Axes & Grid tab controls the display of axes, grids and legend.
|
||||
|
||||
@ -99,7 +99,7 @@ It is just the sum of all data points received by Grafana.
|
||||
|
||||
## Display styles
|
||||
|
||||
|
||||
|
||||
|
||||
Display styles controls properties of the graph.
|
||||
|
||||
@ -144,4 +144,4 @@ a thicker line width to make it standout.
|
||||
|
||||
## Time range
|
||||
|
||||
|
||||
|
||||
|
||||
@ -15,7 +15,7 @@ No mouse? No problem. Grafana has extensive keyboard shortcuts to allow you to n
|
||||
|
||||
Press `Shift`+`?` to open the keyboard shortcut dialog from anywhere within the dashboard views.
|
||||
|
||||
<img class="no-shadow" src="img/docs/v2/Grafana-Keyboard-Shortcuts.gif" style="width:80%;">
|
||||
<img class="no-shadow" src="/img/docs/v2/Grafana-Keyboard-Shortcuts.gif" style="width:80%;">
|
||||
|
||||
|
||||
|Shortcut|Action|
|
||||
|
||||
@ -12,7 +12,7 @@ weight = 5
|
||||
|
||||
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/docs/v2/dashboard_search.png">
|
||||
<img class="no-shadow" src="/img/docs/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 dashboards in real-time.
|
||||
@ -23,7 +23,7 @@ When using only a keyboard, you can use your keyboard arrow keys to navigate the
|
||||
|
||||
## Find by dashboard name
|
||||
|
||||
<img class="no-shadow" src="img/docs/v2/dashboard_search_text.gif">
|
||||
<img class="no-shadow" src="/img/docs/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.
|
||||
|
||||
@ -38,11 +38,11 @@ Tags are a great way to organize your dashboards, especially as the number of da
|
||||
|
||||
To filter the dashboard list by tag, click on any tag appearing in the right column. The list may be further filtered by clicking on additional tags:
|
||||
|
||||
<img class="no-shadow" src="img/docs/v2/dashboard_search_tag_filtering.gif">
|
||||
<img class="no-shadow" src="/img/docs/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/docs/v2/dashboard_search_tags_all_filtering.gif">
|
||||
<img class="no-shadow" src="/img/docs/v2/dashboard_search_tags_all_filtering.gif">
|
||||
|
||||
When using only a keyboard: `tab` to focus on the *tags* link, `▼` down arrow key to find a tag and select with the `Enter` key.
|
||||
|
||||
@ -53,6 +53,6 @@ When using only a keyboard: `tab` to focus on the *tags* link, `▼` down arrow
|
||||
|
||||
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/docs/v2/dashboard_search_starred_filtering.gif">
|
||||
<img class="no-shadow" src="/img/docs/v2/dashboard_search_starred_filtering.gif">
|
||||
|
||||
When using only a keyboard: `tab` to focus on the *stars* link, `▼` down arrow key to find a tag and select with the `Enter` key.
|
||||
|
||||
@ -22,7 +22,7 @@ A dashboard snapshot is an instant way to share an interactive dashboard publicl
|
||||
(metric, template and annotation) and panel links, leaving only the visible metric data and series names embedded into your dashboard. Dashboard
|
||||
snapshots can be accessed by anyone who has the link and can reach the URL.
|
||||
|
||||
|
||||
|
||||
|
||||
### Publish snapshots
|
||||
You can publish snapshots to you local instance or to [snapshot.raintank.io](http://snapshot.raintank.io). The later is a free service
|
||||
|
||||
@ -11,7 +11,7 @@ weight = 2
|
||||
|
||||
# Singlestat Panel
|
||||
|
||||
|
||||
|
||||
|
||||
The Singlestat Panel allows you to show the one main summary stat of a SINGLE series. It reduces the series into a single number (by looking at the max, min, average, or sum of values in the series). Singlestat also provides thresholds to color the stat or the Panel background. It can also translate the single number into a text value, and show a sparkline summary of the series.
|
||||
|
||||
@ -19,7 +19,7 @@ The Singlestat Panel allows you to show the one main summary stat of a SINGLE se
|
||||
|
||||
The singlestat panel has a normal query editor to allow you define your exact metric queries like many other Panels. Through the Options tab, you can access the Singlestat-specific functionality.
|
||||
|
||||
<img class="no-shadow" src="img/docs/v1/Singlestat-BaseSettings.png">
|
||||
<img class="no-shadow" src="/img/docs/v1/Singlestat-BaseSettings.png">
|
||||
|
||||
1. `Big Value`: Big Value refers to how we display the main stat for the Singlestat Panel. This is always a single value that is displayed in the Panel in between two strings, `Prefix` and `Suffix`. The single number is calculated by choosing a function (min,max,average,current,total) of your metric query. This functions reduces your query into a single numeric value.
|
||||
2. `Font Size`: You can use this section to select the font size of the different texts in the Singlestat Panel, i.e. prefix, value and postfix.
|
||||
@ -32,19 +32,19 @@ The singlestat panel has a normal query editor to allow you define your exact me
|
||||
|
||||
The coloring options of the Singlestat Panel config allow you to dynamically change the colors based on the Singlestat value.
|
||||
|
||||
<img class="no-shadow" src="img/docs/v1/Singlestat-Coloring.png">
|
||||
<img class="no-shadow" src="/img/docs/v1/Singlestat-Coloring.png">
|
||||
|
||||
1. `Background`: This checkbox applies the configured thresholds and colors to the entirety of the Singlestat Panel background.
|
||||
2. `Value`: This checkbox applies the configured thresholds and colors to the summary stat.
|
||||
3. `Thresholds`: Change the background and value colors dynamically within the panel, depending on the Singlestat value. The threshold field accepts **2 comma-separated** values which represent 3 ranges that correspond to the three colors directly to the right. For example: if the thresholds are 70, 90 then the first color represents < 70, the second color represents between 70 and 90 and the third color represents > 90.
|
||||
4. `Colors`: Select a color and opacity
|
||||
5. `Invert order`: This link toggles the threshold color order.</br>For example: Green, Orange, Red (<img class="no-shadow" src="img/docs(v1/gyr.png">) will become Red, Orange, Green (<img class="no-shadow" src="img/docs/v1/ryg.png">).
|
||||
5. `Invert order`: This link toggles the threshold color order.</br>For example: Green, Orange, Red (<img class="no-shadow" src="/img/docs(v1/gyr.png">) will become Red, Orange, Green (<img class="no-shadow" src="/img/docs/v1/ryg.png">).
|
||||
|
||||
### Spark Lines
|
||||
|
||||
Sparklines are a great way of seeing the historical data related to the summary stat, providing valuable context at a glance. Sparklines act differently than traditional Graph Panels and do not include x or y axis, coordinates, a legend, or ability to interact with the graph.
|
||||
|
||||
<img class="no-shadow" src="img/docs/v1/Singlestat-Sparklines.png">
|
||||
<img class="no-shadow" src="/img/docs/v1/Singlestat-Sparklines.png">
|
||||
|
||||
1. `Show`: The show checkbox will toggle whether the spark line is shown in the Panel. When unselected, only the Singlestat value will appear.
|
||||
2. `Background`: Check if you want the sparklines to take up the full panel width, or uncheck if they should be below the main Singlestat value.
|
||||
@ -57,13 +57,13 @@ Sparklines are a great way of seeing the historical data related to the summary
|
||||
|
||||
Value to text mapping allows you to translate the value of the summary stat into explicit text. The text will respect all styling, thresholds and customization defined for the value. This can be useful to translate the number of the main Singlestat value into a context-specific human-readable word or message.
|
||||
|
||||
<img class="no-shadow" src="img/docs/v1/Singlestat-ValueMapping.png">
|
||||
<img class="no-shadow" src="/img/docs/v1/Singlestat-ValueMapping.png">
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Multiple Series Error
|
||||
|
||||
<img class="no-shadow" src="img/docs/v2/Singlestat-MultiSeriesError.png">
|
||||
<img class="no-shadow" src="/img/docs/v2/Singlestat-MultiSeriesError.png">
|
||||
|
||||
|
||||
Grafana 2.5 introduced stricter checking for multiple-series on singlestat panels. In previous versions, the panel logic did not verify that only a single series was used, and instead, displayed the first series encountered. Depending on your data source, this could have lead to inconsistent data being shown and/or a general confusion about which metric was being displayed.
|
||||
|
||||
@ -11,7 +11,7 @@ weight = 2
|
||||
|
||||
# Table Panel
|
||||
|
||||
<img src="assets/img/features/table-panel.png">
|
||||
<img src="/assets/img/features/table-panel.png">
|
||||
|
||||
The new table panel is very flexible, supporting both multiple modes for time series as well as for
|
||||
table, annotation and raw JSON data. It also provides date formatting and value formatting and coloring options.
|
||||
@ -22,7 +22,7 @@ To view table panels in action and test different configurations with sample dat
|
||||
|
||||
The table panel has many ways to manipulate your data for optimal presentation.
|
||||
|
||||
<img class="no-shadow" src="img/docs/v2/table-config2.png">
|
||||
<img class="no-shadow" src="/img/docs/v2/table-config2.png">
|
||||
|
||||
1. `Data`: Control how your query is transformed into a table.
|
||||
2. `Table Display`: Table display options.
|
||||
@ -30,7 +30,7 @@ The table panel has many ways to manipulate your data for optimal presentation.
|
||||
|
||||
## Data to Table
|
||||
|
||||
<img class="no-shadow" src="img/docs/v2/table-data-options.png">
|
||||
<img class="no-shadow" src="/img/docs/v2/table-data-options.png">
|
||||
|
||||
The data section contains the **To Table Transform (1)**. This is the primary option for how your data/metric
|
||||
query should be transformed into a table format. The **Columns (2)** option allows you to select what columns
|
||||
@ -38,38 +38,38 @@ you want in the table. Only applicable for some transforms.
|
||||
|
||||
### Time series to rows
|
||||
|
||||
<img src="img/docs/v2/table_ts_to_rows2.png">
|
||||
<img src="/img/docs/v2/table_ts_to_rows2.png">
|
||||
|
||||
In the most simple mode you can turn time series to rows. This means you get a `Time`, `Metric` and a `Value` column. Where `Metric` is the name of the time series.
|
||||
|
||||
### Time series to columns
|
||||
|
||||
|
||||
|
||||
|
||||
This transform allows you to take multiple time series and group them by time. Which will result in the primary column being `Time` and a column for each time series.
|
||||
|
||||
### Time series aggregations
|
||||
|
||||
|
||||
|
||||
This table transformation will lay out your table into rows by metric, allowing columns of `Avg`, `Min`, `Max`, `Total`, `Current` and `Count`. More than one column can be added.
|
||||
|
||||
### Annotations
|
||||
|
||||
|
||||
|
||||
If you have annotations enabled in the dashboard you can have the table show them. If you configure this
|
||||
mode then any queries you have in the metrics tab will be ignored.
|
||||
|
||||
### JSON Data
|
||||
|
||||
|
||||
|
||||
If you have an Elasticsearch **Raw Document** query or an Elasticsearch query without a `date histogram` use this
|
||||
transform mode and pick the columns using the **Columns** section.
|
||||
|
||||
|
||||
|
||||
|
||||
## Table Display
|
||||
|
||||
<img class="no-shadow" src="img/docs/v2/table-display.png">
|
||||
<img class="no-shadow" src="/img/docs/v2/table-display.png">
|
||||
|
||||
1. `Pagination (Page Size)`: The table display fields allow you to control The `Pagination` (page size) is the threshold at which the table rows will be broken into pages. For example, if your table had 95 records with a pagination value of 10, your table would be split across 9 pages.
|
||||
2. `Scroll`: The `scroll bar` checkbox toggles the ability to scroll within the panel, when unchecked, the panel height will grow to display all rows.
|
||||
@ -80,7 +80,7 @@ transform mode and pick the columns using the **Columns** section.
|
||||
|
||||
The column styles allow you control how dates and numbers are formatted.
|
||||
|
||||
<img class="no-shadow" src="img/docs/v2/Column-Options.png">
|
||||
<img class="no-shadow" src="/img/docs/v2/Column-Options.png">
|
||||
|
||||
1. `Name or regex`: The Name or Regex field controls what columns the rule should be applied to. The regex or name filter will be matched against the column name not against column values.
|
||||
2. `Type`: The three supported types of types are `Number`, `String` and `Date`.
|
||||
|
||||
@ -10,7 +10,7 @@ weight = 1
|
||||
|
||||
# Templating
|
||||
|
||||
<img class="no-shadow" src="img/docs/v2/templating_var_list.png">
|
||||
<img class="no-shadow" src="/img/docs/v2/templating_var_list.png">
|
||||
|
||||
Dashboard Templating allows you to make your Dashboards more interactive and dynamic.
|
||||
|
||||
@ -49,7 +49,7 @@ For example, if you were using Templating to list all 20 of your applications, y
|
||||
|
||||
> Note: Multi-Select Tagging functionality is currently experimental but is part of Grafana 2.1. To enable this feature click the enable icon when editing Template options for a particular variable.
|
||||
|
||||
<img class="no-shadow" src="img/docs/v2/template-tags-config.png">
|
||||
<img class="no-shadow" src="/img/docs/v2/template-tags-config.png">
|
||||
|
||||
Grafana gets the list of tags and the list of values in each tag by performing two queries on your metric namespace.
|
||||
|
||||
@ -61,13 +61,13 @@ Note: a proof of concept shim that translates the metric query into a SQL call i
|
||||
|
||||
Once configured, Multi-Select Tagging provides a convenient way to group and your template variables, and slice your data in the exact way you want. The Tags can be seen on the right side of the template pull-down.
|
||||
|
||||
|
||||
|
||||
|
||||
### Interval
|
||||
|
||||
Use the `Interval` type to create Template variables around time ranges (eg. `1m`,`1h`, `1d`). There is also a special `auto` option that will change depending on the current time range, you can specify how many times the current time range should be divided to calculate the current `auto` range.
|
||||
|
||||
|
||||
|
||||
|
||||
### Custom
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ weight = 7
|
||||
|
||||
Grafana provides numerous ways to manage the time ranges of the data being visualized, both at the Dashboard-level and the Panel-level.
|
||||
|
||||
<img class="no-shadow" src="img/docs/whatsnew_2_5/timepicker.png">
|
||||
<img class="no-shadow" src="/img/docs/whatsnew_2_5/timepicker.png">
|
||||
|
||||
In the top right, you have the master Dashboard time picker (it's in between the 'Zoom out' and the 'Refresh' links).
|
||||
|
||||
@ -43,7 +43,7 @@ Previous Month | `now-1M/M` | `now-1M/M`
|
||||
|
||||
There are two settings available from the Dashboard Settings area, allowing customization of the auto-refresh intervals and the definition of `now`.
|
||||
|
||||
<img class="no-shadow" src="img/docs/v2/TimePicker-TimeOptions.png">
|
||||
<img class="no-shadow" src="/img/docs/v2/TimePicker-TimeOptions.png">
|
||||
|
||||
### Auto-Refresh Options
|
||||
|
||||
@ -59,11 +59,11 @@ Users often ask, [when will then be now](https://www.youtube.com/watch?v=VeZ9HhH
|
||||
|
||||
You can override the relative time range for individual panels, causing them to be different than what is selected in the Dashboard time picker in the upper right. This allows you to show metrics from different time periods or days at the same time.
|
||||
|
||||
<img class="no-shadow" src="img/docs/v2/panel_time_override.jpg">
|
||||
<img class="no-shadow" src="/img/docs/v2/panel_time_override.jpg">
|
||||
|
||||
You control these overrides in panel editor mode and the tab `Time Range`.
|
||||
|
||||
<img class="no-shadow" src="img/docs/v2/time_range_tab.jpg">
|
||||
<img class="no-shadow" src="/img/docs/v2/time_range_tab.jpg">
|
||||
|
||||
When you zoom or change the Dashboard time to a custom absolute time range, all panel overrides will be disabled. The panel relative time override is only active when the dashboard time is also relative. The panel timeshift override is always active, even when the dashboard time is absolute.
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ take you to the graph.
|
||||
> is so Hipchat and Slack can show them reliably (they require the image to be publicly available).
|
||||
|
||||
<div class="text-center">
|
||||
<img src="img/tutorials/hubot_grafana.png" class="center"></a>
|
||||
<img src="/img/tutorials/hubot_grafana.png" class="center"></a>
|
||||
</div>
|
||||
|
||||
## What is Hubot?
|
||||
@ -70,7 +70,7 @@ To verify that this feature works try the `Direct link to rendered image` link i
|
||||
If you do not get an image when opening this link verify that the required font packages are installed for phantomjs to work.
|
||||
|
||||
### Grafana API Key
|
||||
<img src="img/v2/orgdropdown_api_keys.png" style="width: 150px" class="right"></img>
|
||||
<img src="/img/v2/orgdropdown_api_keys.png" style="width: 150px" class="right"></img>
|
||||
You need to set the environment variable `HUBOT_GRAFANA_API_KEY` to a Grafana API Key.
|
||||
You can add these from the API Keys page which you find in the Organization dropdown.
|
||||
|
||||
@ -115,7 +115,7 @@ Now you can add an alias like this:
|
||||
|
||||
<div class="text-center">
|
||||
Using the alias:<br>
|
||||
<img src="img/tutorials/hubot_grafana2.png" class="center"></a>
|
||||
<img src="/img/tutorials/hubot_grafana2.png" class="center"></a>
|
||||
</div>
|
||||
|
||||
## Summary
|
||||
|
||||
Loading…
Reference in New Issue
Block a user