Commit de94b48d by Torkel Ödegaard

Merge pull request #1597 from jwilder/jw-graph

Update graph docs for v2
parents 17063df3 aca83479
...@@ -4,29 +4,136 @@ title: Docs - Graphing ...@@ -4,29 +4,136 @@ title: Docs - Graphing
# Graphing # Graphing
The main panel for in Grafana is simply named Graph. It provides a very rich set of graphing options. The main panel in Grafana is simply named Graph. It provides a very rich set of graphing options.
<img src="/img/v1/graph_overview.png" class="no-shadow"> <img src="/img/v1/graph_overview.png" class="no-shadow">
## Axes, Grid & Legend options Clicking the title for a panel exposes a menu. The `edit` option opens additional configuration
![](/img/v1/graph_axes_grid_options.png) options for the panel.
### Legens values ## General
![](/img/v2/graph_general.png)
Check ``Include Values`` under legend styles. The general tab allows customization of a panel's appearance and menu options.
- Total - Sum of all values returned from metric query ### General Options
- Current - Last value returned from the metric query
- ``Title`` - The panel title on the dashboard
- ``Span`` - The panel width in columns
- ``Height`` - The panel contents height in pixels
### Drilldown / detail link
The drilldown section allows adding dynamic links to the panel that can link to other dashboards
or URLs
Each link has a title, a type and params. A link can be either a ``dashboard`` or ``absolute`` links.
If it is a dashboard links, the `dashboard` value must be the name of a dashbaord. If it's an
`absolute` link, the URL is the URL to link.
``params`` allows adding additional URL params to the links. The format is the ``name=value`` with
multiple params separate by ``&``. Template variables can be added as values using ``$myvar``.
When linking to another dashboard that uses template variables, you can use ``var-myvar=value`` to
populate the template variable to a desired value from the link.
## Metrics
The metrics tab defines what series data and sources to render. Each datasource provides different
options.
### Graphite
### InfluxDB
### OpenTSDB
## Axes & Grid
![](/img/v2/graph_axes_grid_options.png)
The Axes & Grid tab controls the display of axes, grids and legend.
### Axes
The ``Left Y`` and ``Right Y`` can be customized using:
- ``Unit`` - The display unit for the Y value
- ``Grid Max`` - The maximum Y value. (default auto)
- ``Grid Min`` - The minium Y value. (default auto)
- ``Label`` - The Y axis label (default "")
Axes can also be hidden by unchecking the appropriate box from `Show Axis`.
Thresholds allow you to add arbitrary lines or sections to the graph to make it easier to see when
the graph crosses a particular threshold.
### Legend
The legend hand be hidden by checking the ``Show`` checkbox. If it's shown, it can be
displayed as a table of values by checking the ``Table`` checkbox. Series with no
values can be hidden from the legend using the ``Hide empty`` checkbox.
### Legend Values
Additional values can be shown along-side the legend names:
- ``Total`` - Sum of all values returned from metric query
- ``Current`` - Last value returned from the metric query
- ``Min`` - Minimum of all values returned from metric query
- ``Max`` - Maximum of all values returned from the metric query
- ``Avg`` - Average of all values returned from metric query
- ``Decimals`` - Controls how many decimals are displayed for legend values
This means that if your series represents a rate, for example requests / second then the Total in the legend will This means that if your series represents a rate, for example requests / second then the Total in the legend will
not represent the total number of requests. It is just the sum of all data points. not represent the total number of requests. It is just the sum of all data points.
## Display options ## Display styles
![](/img/v1/graph_display_styles.png)
![](/img/v2/graph_display_styles.png)
Display styles controls properties of the graph.
### Chart Options
- ``Bar`` - Display values as a bar chart
- ``Lines`` - Display values as a line graph
- ``Points`` - Display points for values
### Line Options
- ``Line Fill`` - Amount of color fill for a series. 0 is none.
- ``Line Width`` - The width of the line for a series.
- ``Null point mode`` - How null values are displayed
- ``Staircase line`` - Draws adjacent points as staircase
### Multiple Series
If there are multiple series, they can be display as a group.
- ``Stack`` - Each series is stacked on top of another
- ``Percent`` - Each series is draw as a percent of the total of all series
If you have stack enabled you can select what the mouse hover feature should show. If you have stack enabled you can select what the mouse hover feature should show.
- Cumulative - Sum of series below plus the series you hover over - Cumulative - Sum of series below plus the series you hover over
- Individual - Just the value for the series you hover over - Individual - Just the value for the series you hover over
### Rendering
- ``Flot`` - Render the graphs in the browser using Flot (default)
- ``Graphite PNG`` - Render the graph on the server using graphites render API.
### Tooltip
- ``All series`` - Show all series on the same tooltip and a x crosshairs to help follow all series
### Series specific overrides
The section allows a series to be render different from the rest. For example, one series can be given
a thicker line width to make it standout.
## Time range
![](/img/v2/graph_time_range.png)
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