Files
Torkel Ödegaard 335cec07a5 Graph: Add data links feature (click on graph) (#17267)
* WIP: initial panel links editor

* WIP: Added dashboard migration to new panel drilldown link schema

* Make link_srv interpolate new variables

* Fix failing tests

* Drilldown: Add context menu to graph viz (#17284)

* Add simple context menu for adding graph annotations and showing drilldown links

* Close graph context menu when user start scrolling

* Move context menu component to grafana/ui

* Make graph context menu appear on click, use cmd/ctrl click for quick annotations

* Move graph context menu controller to separate file

* Drilldown: datapoint variables interpolation (#17328)

* Add simple context menu for adding graph annotations and showing drilldown links

* Close graph context menu when user start scrolling

* Move context menu component to grafana/ui

* Make graph context menu appear on click, use cmd/ctrl click for quick annotations

* Add util for absolute time range transformation

* Add series name and datapoint timestamp interpolation

* Rename drilldown link variables tot snake case, use const values instead of strings in tests

* Bring LinkSrv.getPanelLinkAnchorInfo for compatibility reasons and add deprecation warning

* Rename seriesLabel to seriesName

* Drilldown: use separate editors for panel and series links (#17355)

* Use correct target ini context menu links

* Rename PanelLinksEditor to DrilldownLinksEditor and mote it to grafana/ui

* Expose DrilldownLinksEditor as an angular directive

* Enable visualization specifix drilldown links

* Props interfaces rename

* Drilldown: Add variables suggestion and syntax highlighting for drilldown link editor (#17391)

* Add variables suggestion in drilldown link editor

* Enable prism

* Fix backspace not working

* Move slate value helpers to grafana/ui

* Add syntax higlighting for links input

* Rename drilldown link components to data links

* Add template variabe suggestions

* Bugfix

* Fix regexp not working in Firefox

* Display correct links in panel header corner

* bugfix

* bugfix

* Bugfix

* Context menu UI tweaks

* Use data link terminology instead of drilldown

* DataLinks: changed autocomplete syntax

* Use singular form for data link

* Use the same syntax higlighting for built-in and template variables in data links editor

* UI improvements to context menu

* UI review tweaks

* Tweak layout of data link editor

* Fix vertical spacing

* Remove data link header in context menu

* Remove pointer cursor from series label in context menu

* Fix variable selection on click

* DataLinks: migrations for old links

* Update docs about data links

* Use value time instead of time range when interpolating datapoint timestamp

* Remove not used util

* Update docs

* Moved icon a bit more down

* Interpolate value ts only when using __value_time variable

* Bring href property back to LinkModel

* Add any type annotations

* Fix TS error on slate's Value type

* minor changes
2019-06-25 11:38:51 +02:00

9.1 KiB

+++ title = "Graph Panel" keywords = ["grafana", "graph panel", "documentation", "guide", "graph"] type = "docs" aliases = ["/reference/graph/"] [menu.docs] name = "Graph" parent = "panels" weight = 1 +++

Graph Panel

{{< docs-imagebox img="/img/docs/v45/graph_overview.png" class="docs-image--no-shadow" max-width="850px" >}}

The main panel in Grafana is simply named Graph. It provides a very rich set of graphing options.

  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.

General

{{< docs-imagebox img="/img/docs/v51/graph_general.png" max-width= "800px" >}}

The general tab allows customization of a panel's appearance and menu options.

Info

  • Title - The panel title of the dashboard, displayed at the top.
  • Description - The panel description, displayed on hover of info icon in the upper left corner of the panel.
  • Transparent - If checked, removes the solid background of the panel (default not checked).

Repeat

Repeat a panel for each value of a variable. Repeating panels are described in more detail [here]({{< relref "../../reference/templating.md#repeating-panels" >}}).

Data link in graph settings allows adding dynamic links to the visualization. Those links can link to either other dashboard or to an external URL.

{{< docs-imagebox img="/img/docs/data_link.png" max-width= "800px" >}}

Data link is defined by title, url and a setting whether or not it should be opened in a new window.

Title is a human readable label for the link that will be displayed in the UI. The link itself is accessible in the graph's context menu when user clicks on a single data point:

{{< docs-imagebox img="/img/docs/data_link_tooltip.png" max-width= "800px" >}}

URL field allows the URL configuration for a given link. Apart from regular query params it also supports built-in variables and dashboard variables that you can choose from available suggestions:

{{< docs-imagebox img="/img/docs/data_link_typeahead.png" max-width= "800px" >}}

Available built-in variables are:

  1. __all_variables - will add all current dashboard's variables to the URL
  2. __url_time_range - will add current dashboard's time range to the URL (i.e. ?from=now-6h&to=now)
  3. __series_name - will add series name as a query param in the URL (i.e. ?series=B-series)
  4. __value_time - will add datapoint's timestamp (Unix ms epoch) to the URL (i.e. ?time=1560268814105)

When linking to another dashboard that uses template variables, you can use var-myvar=${myvar} syntax (where myvar is a name of template variable) to use current dashboard's variable value.

Metrics

The metrics tab defines what series data and sources to render. Each datasource provides different options.

Axes

{{< docs-imagebox img="/img/docs/v51/graph_axes_grid_options.png" max-width= "800px" >}}

The Axes tab controls the display of axes.

Left Y/Right Y

The Left Y and Right Y can be customized using:

  • Unit - The display unit for the Y value
  • Scale - The scale to use for the Y value, linear or logarithmic. (default linear)
  • Y-Min - The minimum Y value. (default auto)
  • Y-Max - The maximum Y value. (default auto)
  • Decimals - Controls how many decimals are displayed for Y value (default auto)
  • Label - The Y axis label (default "")

Axes can also be hidden by unchecking the appropriate box from Show.

X-Axis

Axis can be hidden by unchecking Show.

For Mode there are three options:

  • The default option is Time and means the x-axis represents time and that the data is grouped by time (for example, by hour or by minute).

  • The Series option means that the data is grouped by series and not by time. The y-axis still represents the value.

    {{< docs-imagebox img="/img/docs/v51/graph-x-axis-mode-series.png" max-width="800px">}}

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

Y-Axes

  • Align - Check to align left and right Y-axes by value (default unchecked/false)
  • Level - Available when Align is checked. Value to use for alignment of left and right Y-axes, starting from Y=0 (default 0)

Legend

{{< docs-imagebox img="/img/docs/v51/graph-legend.png" max-width= "800px" >}}

Options

  • Show - Uncheck to hide the legend (default checked/true)
  • Table - Check to display legend in table (default unchecked/false)
  • To the right - Check to display legend to the right (default unchecked/false)
  • Width - Available when To the right is checked. Value to control the minimum width for the legend (default 0)

Values

Additional values can be shown along-side the legend names:

  • 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
  • Current - Last value returned from the metric query
  • Total - Sum of all values returned from metric query
  • Decimals - Controls how many decimals are displayed for legend values (and graph hover tooltips)

The legend values are calculated client side by Grafana and depend on what type of aggregation or point consolidation your metric query is using. All the above legend values cannot be correct at the same time. For example if you plot a rate like requests/second, this is probably using average as aggregator, then the Total in the legend will not represent the total number of requests. It is just the sum of all data points received by Grafana.

Hide series

Hide series when all values of a series from a metric query are of a specific value:

  • With only nulls - Value=null (default unchecked)
  • With only zeros - Value=zero (default unchecked)

Display styles

{{< docs-imagebox img="/img/docs/v51/graph_display_styles.png" max-width= "800px" >}}

Display styles control visual properties of the graph.

Draw Options

Draw Modes

  • Bar - Display values as a bar chart
  • Lines - Display values as a line graph
  • Points - Display points for values

Mode Options

  • Fill - Amount of color fill for a series (default 1). 0 is none.
  • Line Width - The width of the line for a series (default 1).
  • Staircase - Draws adjacent points as staircase
  • Points Radius - Adjust the size of points when Points are selected as Draw Mode.

Hover tooltip

  • Mode - Controls how many series to display in the tooltip when hover over a point in time, All series or single (default All series).
  • Sort order - Controls how series displayed in tooltip are sorted, None, Ascending or Descending (default None).
  • Stacked value - Available when Stack are checked and controls how stacked values are displayed in tooltip (default Individual).
    • Individual: the value for the series you hover over
    • Cumulative - sum of series below plus the series you hover over

Stacking & Null value

If there are multiple series, they can be displayed as a group.

  • Stack - Each series is stacked on top of another
  • Percent - Available when Stack are checked. Each series is drawn as a percentage of the total of all series
  • Null value - How null values are displayed

Series overrides

{{< docs-imagebox img="/img/docs/v51/graph_display_overrides.png" max-width= "800px" >}}

The section allows a series to be rendered differently from the others. For example, one series can be given a thicker line width to make it stand out and/or be moved to the right Y-axis.

Dashes Drawing Style

There is an option under Series overrides to draw lines as dashes. Set Dashes to the value True to override the line draw setting for a specific series.

Thresholds

{{< docs-imagebox img="/img/docs/v51/graph_display_thresholds.png" max-width= "800px" >}}

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.

Time Regions

Only available in Grafana v5.4 and above.

{{< docs-imagebox img="/img/docs/v54/graph_time_regions.png" max-width= "800px" >}}

Time regions allow you to highlight certain time regions of the graph to make it easier to see for example weekends, business hours and/or off work hours.

Time Range

{{< docs-imagebox img="/img/docs/v51/graph-time-range.png" max-width= "900px" >}}

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. Panel time overrides & timeshift are described in more detail [here]({{< relref "reference/timerange.md#panel-time-overrides-timeshift" >}}).