Commit f5e8a406 by Torkel Ödegaard

docs: minor fixes for #9369

parents 1dea7dab 0a65100e
+++
title = "Alert List"
keywords = ["grafana", "alert list", "documentation", "panel", "alertlist"]
type = "docs"
aliases = ["/reference/alertlist/"]
[menu.docs]
name = "Alert list"
parent = "panels"
weight = 4
+++
# Alert List Panel
{{< docs-imagebox img="/img/docs/v45/alert-list-panel.png" max-width="700px" >}}
The alert list panel allows you to display your dashbords alerts. The list can be configured to show current state or recent state changes. You can read more about alerts [here](http://docs.grafana.org/alerting/rules).
## Alert List Options
{{< docs-imagebox img="/img/docs/v45/alert-list-options.png" max-width="600px" class="docs-image--no-shadow">}}
1. `Show`: Lets you choose between current state or recent state changes.
2. `Max Items`: Max items set the maximum of items in a list.
3. `Sort Order`: Lets you sort your list alphabeticaly(asc/desc) or by importance.
4. `Alerts From This Dashboard`: Shows alerts only from the dashboard the alert list is in.
5. `State Filter`: Here you can filter your list by one or more parameters.
\ No newline at end of file
......@@ -12,7 +12,7 @@ weight = 4
# Dashboard List Panel
{{< docs-imagebox img="/img/docs/v45/dashboard-list-panels.png" max-width= "800px" >}}
{{< docs-imagebox img="/img/docs/v45/dashboard-list-panels.png" max-width="850px">}}
The dashboard list panel allows you to display dynamic links to other dashboards. The list can be configured to use starred dashboards, recently viewed dashboards, a search query and/or dashboard tags.
......@@ -20,15 +20,17 @@ The dashboard list panel allows you to display dynamic links to other dashboards
## Dashboard List Options
{{< docs-imagebox img="/img/docs/v45/dashboard-list-options.png" max-width="600px" class="docs-image--no-shadow">}}
{{< docs-imagebox img="/img/docs/v45/dashboard-list-options.png" class="docs-image--no-shadow docs-image--right">}}
1. `Starred`: The starred dashboard selection displays starred dashboards in alphabetical order.
2. `Recently Viewed`: The recently viewed dashboard selection displays recently viewed dashboards in alphabetical order.
3. `Search`: The search dashboard selection displays dashboards by search query or tag(s).
4. `Show Headings`: When show headings is ticked the choosen list selection(Starred, Recently Viewed, Search) is shown as a heading.
5. `Max Items`: Max items set the maximum of items in a list.
6. `Query`: Here is where you enter your query you want to search by. Queries are case-insensitive, and partial values are accepted.
7. `Tags`: Here is where you enter your tag(s) you want to search by. 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.
1. **Starred**: The starred dashboard selection displays starred dashboards in alphabetical order.
2. **Recently Viewed**: The recently viewed dashboard selection displays recently viewed dashboards in alphabetical order.
3. **Search**: The search dashboard selection displays dashboards by search query or tag(s).
4. **Show Headings**: When show headings is ticked the choosen list selection(Starred, Recently Viewed, Search) is shown as a heading.
5. **Max Items**: Max items set the maximum of items in a list.
6. **Query**: Here is where you enter your query you want to search by. Queries are case-insensitive, and partial values are accepted.
7. **Tags**: Here is where you enter your tag(s) you want to search by. 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.
<div class="clearfix"></div>
> When multiple tags and strings appear, the dashboard list will display those matching ALL conditions.
......
......@@ -13,9 +13,10 @@ weight = 1
The main panel in Grafana is simply named Graph. It provides a very rich set of graphing options.
{{< docs-imagebox img="/img/docs/v45/graph_overview.png" class="docs-image--no-shadow" max-width= "900px" >}}
<img src="/img/docs/v45/graph_overview.png" class="no-shadow">
1. Clicking the title for a panel exposes a menu. The `edit` option opens additional configuration options for the panel.
1. Clicking the title for a panel exposes a menu. The `edit` option opens additional configuration
options for the panel.
2. Click to open color & axis selection.
3. Click to only show this series. Shift/Ctrl + click to hide series.
......@@ -72,7 +73,7 @@ There are three options:
- The `Series` option means that the data is grouped by series and not by time. The y-axis still represents the value.
<img src="/img/docs/v4/x_axis_mode_series.png" class="no-shadow">
{{< docs-imagebox img="/img/docs/v45/graph-x-axis-mode-series.png" max-width="700px">}}
- The `Histogram` option converts the graph into a histogram. A Histogram is a kind of bar chart that groups numbers into ranges, often called buckets or bins. Taller bars show that more data falls in that range. Histograms and buckets are described in more detail [here](http://docs.grafana.org/features/panels/heatmap/#histograms-and-buckets).
......@@ -157,6 +158,12 @@ There is an option under Series overrides to draw lines as dashes. Set Dashes to
## Time Range
<<<<<<< HEAD
The time range tab allows you to override the dashboard time range and specify a panel specific time. Either through a relative from now time option or through a timeshift.
{{< docs-imagebox img="/img/docs/v45/graph-time-range.png" max-width= "900px" >}}
||||||| merged common ancestors
![](/img/docs/v2/graph_time_range.png)
=======
<img src="/img/docs/v45/graph-time-range.png" class="no-shadow">
>>>>>>> 0a65100eaf64cd57b38110001bf614630821610c
......@@ -12,7 +12,7 @@ weight = 2
# Singlestat Panel
{{< docs-imagebox img="/img/docs/v45/singlestat-panel.png" max-width="900px" >}}
{{< docs-imagebox img="/img/docs/v45/singlestat-panel.png" class="docs-image--no-shadow">}}
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.
......@@ -20,7 +20,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.
{{< docs-imagebox img="/img/docs/v45/singlestat-value-options.png" class="docs-image--no-shadow" max-width= "900px" >}}
<img class="no-shadow" src="/img/docs/v45/singlestat-value-options.png">
1. `Stats`: The Stats field let you set the function (min, max, average, current, total, first, delta, range) that your entire query is reduced into a single value with. This reduces the entire query into a single summary value that is displayed.
* `min` - The smallest value in the series
......@@ -64,6 +64,7 @@ Sparklines are a great way of seeing the historical data related to the summary
> ***Pro-tip:*** Reduce the opacity on fill colors for nice looking panels.
<<<<<<< HEAD
### Gauge
Gauges gives a clear picture of how high a value is in it's context. It's a great way to see if a value is close to the thresholds. The gauge uses the colors set in the color options.
......@@ -77,13 +78,39 @@ Gauges gives a clear picture of how high a value is in it's context. It's a grea
<div class="clearfix"></div>
||||||| merged common ancestors
=======
### Gauge
Gauges gives a clear picture of how high a value is in it's context. It's a great way to see if a value is close to the thresholds. The gauge uses the colors set in the color options.
{{< docs-imagebox img="/img/docs/v45/singlestat-gauge-options.png" max-width="500px" class="docs-image--right docs-image--no-shadow">}}
1. `Show`: The show checkbox will toggle wether the gauge is shown in the panel. When unselected, only the Singlestat value will appear.
2. `Min/Max`: This sets the start and end point for the gauge.
3. `Threshold Labels`: Check if you want to show the threshold labels. Thresholds are set in the color options.
4. `Threshold Markers`: Check if you want to have a second meter showing the thresholds.
>>>>>>> 0a65100eaf64cd57b38110001bf614630821610c
### Value to text mapping
<<<<<<< HEAD
{{< docs-imagebox img="/img/docs/v45/singlestat-value-mapping.png" class="docs-image--right docs-image--no-shadow">}}
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.
||||||| merged common ancestors
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.
=======
{{< docs-imagebox img="/img/docs/v45/singlestat-value-mapping.png" class="docs-image--right docs-image--no-shadow">}}
>>>>>>> 0a65100eaf64cd57b38110001bf614630821610c
<<<<<<< HEAD
<div class="clearfix"></div>
||||||| merged common ancestors
<img class="no-shadow" src="/img/docs/v1/Singlestat-ValueMapping.png">
=======
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.
>>>>>>> 0a65100eaf64cd57b38110001bf614630821610c
## Troubleshooting
......
+++
title = "Text"
keywords = ["grafana", "text", "documentation", "panel"]
type = "docs"
aliases = ["/reference/alertlist/"]
[menu.docs]
name = "Text"
parent = "panels"
weight = 4
+++
# Text Panel
The text panel lets you make information and description panels etc. for your dashboards. There are three modes you can write in: markdown, HTML or text.
## Text Options
{{< docs-imagebox img="/img/docs/v45/text-options.png" max-width="600px" class="docs-image--no-shadow">}}
1. `Mode`: Here you can choose between markdown, HTML or text.
2. `Content`: Here you write your content.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment