Soracom Lagoon

Graph Panel

The Graph Panel displays data series as a graph or chart, and provides several options for configuring the look and feel of the panel. You can configure a graph panel to render a simple line, area, or bar graph, a histogram, or multiple series. You can also override individual data series in order to mix and match different visualization options in order to create simple yet informative graphs. Graph panels also give you the ability to create alerts in order to receive notifications when a particular metric exceeds a specified value.

Modes

The graph panel has three modes of operation:

• The Time mode will render a standard graph that shows how metrics change over time. Time will be plotted on the X-axis, and metric values will be plotted on the Y-axis. This mode supports both Left and Right Y-axes, so that you can display data from two metrics with different scales.
• The Series mode will group data into their individual series and render each series as a separate bar or data point. Each metric will listed separately on the X-axis, and the Avg, Min, Max, Total, or Count of each metric's values will be plotted on the Y-axis.
• The Histogram mode will group the values within each data series into separate buckets and render a graph that visualizes how often data falls into each bucket. The range of values will be plotted on the X-axis (the buckets), and the number of data points that fall into each bucket will be plotted on the Y-axis.

The graph panel mode can be configured from the Axes tab.

Creating a Graph Panel

1. Click the Add panel button at the top of the dashboard.

2. From the list of available panels, select Graph.

   The graph panel will be added to your dashboard.

   https://g.lagoon.soracom.io

   

Editing Panel Settings

To edit the graph panel settings, click the Panel Title, then select Edit.

General

The General tab lets you configure basic panel settings. Refer to the Lagoon Panels: General documentation for more information.

Metrics

The Metrics tab lets you configure the data series source. Refer to the Lagoon Panels: Metrics documentation for more information.

Axes

The Axes tab lets you configure the graph area.

Left Y and Right Y

• Show - Show or hide the axis. Note: By default, data series will be plotted on the Left Y axis, and the Right Y axis will remain hidden. To assign a data series to use the Right Y-axis instead, refer to the Display: Series overrides configuration below.
• Unit - Add a unit to the Y-axis values, such as degrees for a temperature metric, percentage for a humidity metric, or length for a distance metric.
• Scale - The type of scale to use on the Y-axis.
• Y-Min and Y-Max - Specify the minimum and maximum values of the Y-axis. If blank, the Y-axis will be scaled automatically based on the data series.
• Decimals - The number of decimal places to show.
• Label - A custom text label to display on the axis. If blank, no label is shown.

X-Axis

• Show - Show or hide the axis.
• Mode - The type of graph to render.
  • Time - Render the graph as a standard time graph that shows how metrics change over time.
  • Series - Group data into their individual series and render each series as a separate bar or data point.
  • Histogram - Group values within each data series into separate buckets and render a graph that visualizes how often data falls into each bucket.
• Value - When the X-axis Mode is set to Series, this option controls how the data in each series should be calculated, such as Avg, Min, or Max.
• Buckets - When the X-axis Mode is set to Histogram, this option controls how many buckets the data should be split into.

Y-Axes

• Align - When the scales of the Left Y and Right Y axes differ, this option will render both axes with a common or aligned reference point.
• Level - The value at which the Left Y and Right Y axes should be aligned.

Legend

The Legend tab lets you configure a legend that is displayed together with the graph.

Options

• Show - Show or hide the legend.
• As a Table - Display the legend as a table instead of a list of metrics.
• To the right - Display the legend on the right of the graph instead of below.
• Width - If the To the right option is enabled, set the width of the legend.

Values

• Min, Max, Avg, Current, and Total - Display the correspond values of the metrics in the legend.
• Decimals - The number of decimal places to show.

Hide series

• With only nulls - If a data series does not contain any data, hide it.
• With only zeros - If a data series only contains values equal to 0, hide it.

Display

The Display tab lets you configure the basic look and feel of the graph, and also configure overrides for individual data series.

Draw options

Draw Modes

• Bars - Render vertical bars.
• Lines - Render a continuous line.
• Points - Render individual points.

Mode Options

• Fill - When the Line draw mode option is enabled, this controls the opacity of the area between the line and X-axis origin.
• Line Width - When the Line draw mode option is enabled, this controls the width of the line.
• Staircase - When the Line draw mode option is enabled, this option connects adjacent points as a step or discrete value rather than a straight or continuous line. Point Radius - When the Points draw mode option is enabled, this controls the size of each point.

Hover tooltip

• Mode - The data to show in a tooltip when hovering over a data point.
  • All series - Show the Y-axis values for all data series at the same X-axis value.
  • Single - Show the Y-axis value for the hovered data series only.
• Sort order - When the Hover tooltip Mode is set to All series, this controls how the list of values inside the tooltip is sorted:
  • None - Do not change the order of the data series. Each data series will be listed in the same order they are defined in the Metrics tab.
  • Increasing - Sort and display the data series with the smallest values first.
  • Decreasing - Sort and display the data series with the largest values first.
• Stacked value - When the Stacking & Null value Stack option is enabled, this controls how the value in the tooltip should be displayed:
  • cumulative - Display the cumulative sum of all metric values below the current data point.
  • individual - Display only the value of the current data point.

Stacking & Null value

• Stack - Each series is stacked on top of one another.
• Percent - When the Stack option is enabled, this option renders each series as a percentage of the total stacked value rather than the absolute value.
• Null value - Controls how missing or null values are rendered:
  • connected - Render a continuous line connecting the previous value to the next value.
  • null - Render a discontinuous line with a gap where the value is missing.
  • null as zero - Render a continuous line with the missing value as 0.

Series overrides

This section allows you to select a specific data series and override individual display settings, such as changing the bar, line, or point display mode, choosing a different color, adding dashes, and assigning the data series to the second Y-axis.

For each override, the alias or regex option should be a string or regular expression that matches the name of a metric.

Thresholds

This section allows you to create arbitrary lines to make it easier to see when a metric passes a particular value.

A threshold only provides a visualization within the panel and does not provide any notification functionality when a metric passes a threshold. For additional behavior, use the Alert settings instead. When alerts are enabled for the panel, the Thresholds configuration will have no effect.

Alert

The Alert tab lets you configure thresholds for each metric and how notifications should be sent when a metric passes a threshold. Refer to the Lagoon Alerts documentation for more information.

Time Range

The Time Range tab lets you adjust the range of data to use. Refer to the Lagoon Panels: Time Range documentation for more information.

Additional Resources

More information about the graph panel can be found in the Grafana: Graph Panel documentation.