opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-07-29 05:22:32 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(): fixing image urls in docs

Browse Source
This commit is contained in:
Torkel Ödegaard
2016-11-04 20:29:17 +01:00
parent 3cc4a194a9
commit 2b81b204aa
31 changed files with 141 additions and 153 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/sources/guides/getting_started.md
View File

@ -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
![](img/docs/v2/graph_metrics_tab_graphite.png)
![](/img/docs/v2/graph_metrics_tab_graphite.png)
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.
![](img/docs/animated_gifs/drag_drop.gif)
![](/img/docs/animated_gifs/drag_drop.gif)
## 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

14
docs/sources/guides/whats-new-in-v2-1.md
View File

@ -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.
![Multi-Value Select](img/docs/v2/multi-select.gif "Multi-Value Select")
![Multi-Value Select](/img/docs/v2/multi-select.gif "Multi-Value Select")
<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>
![Repeating Rows and Panels](img/docs/v2/panel-row-repeat.gif "Repeating Rows and Panels")
![Repeating Rows and Panels](/img/docs/v2/panel-row-repeat.gif "Repeating Rows and Panels")
<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](img/docs/v2/dash_links.png "Dashboard Links")
![Dashboard Links](/img/docs/v2/dash_links.png "Dashboard Links")
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.
![InfluxDB Editor](img/docs/v2/influx_09_editor_anim.gif "InfluxDB Editor")
![InfluxDB Editor](/img/docs/v2/influx_09_editor_anim.gif "InfluxDB Editor")
<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.
![Define series color using regex rule](img/docs/v2/regex_color_override.png "Define series color using regex rule")
![Define series color using regex rule](/img/docs/v2/regex_color_override.png "Define series color using regex rule")
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.
![Negative-y Transform](img/docs/v2/negative-y.png "Negative-y Transform")
![Negative-y Transform](/img/docs/v2/negative-y.png "Negative-y Transform")
![Negative-y Transform](img/docs/v2/negative-y-form.png "Negative-y Transform")
![Negative-y Transform](/img/docs/v2/negative-y-form.png "Negative-y Transform")
### Singlestat Panel
Now support string values. Useful for time series database like InfluxDB that supports

14
docs/sources/guides/whats-new-in-v2-5.md
View File

@ -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.

22
docs/sources/guides/whats-new-in-v2-6.md
View File

@ -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:
![](img/docs/influxdb/select_editor.png)
![](/img/docs/influxdb/select_editor.png)
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

20
docs/sources/guides/whats-new-in-v2.md
View File

@ -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.
![](img/docs/v2/dashboard_snapshot_dialog.png)
![](/img/docs/v2/dashboard_snapshot_dialog.png)
### 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.
![](img/docs/v2/panel_time_override.jpg)
![](/img/docs/v2/panel_time_override.jpg)
You control these overrides in panel editor mode and the new tab `Time Range`.
![](img/docs/v2/time_range_tab.jpg)
![](/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 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
![](img/docs/v2/dashboard_search.jpg)
![](/img/docs/v2/dashboard_search.jpg)
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)
![](img/docs/v2/graph_logbase10_ms.png)
![](/img/docs/v2/graph_logbase10_ms.png)
## Dashlist panel
![](img/docs/v2/dashlist_starred.png)
![](/img/docs/v2/dashlist_starred.png)
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.
![](img/docs/v2/timepicker_now_delay.jpg)
![](/img/docs/v2/timepicker_now_delay.jpg)
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.
![](img/docs/v2/overwrite_protection.jpg)
![](/img/docs/v2/overwrite_protection.jpg)
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.
![](img/docs/v2/share_dialog_image_highlight.jpg)
![](/img/docs/v2/share_dialog_image_highlight.jpg)

8
docs/sources/guides/whats-new-in-v3-1.md
View File

@ -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

24
docs/sources/guides/whats-new-in-v3.md
View File

@ -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)