Splunk® Dashboards App

Splunk Dashboards app (beta) for Enterprise and Cloud

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Filler and marker gauges

Use a filler or marker gauge to map a value in relation to a range. A gauge visualization provides metric status and range information that you can interpret quickly. You can use a real-time search to generate a gauge tracking value fluctuations as they occur.

Data formatting

To generate a gauge, use a search that returns a single numerical value. For example, use a search that returns an event count for events with a specific field value in a time period or real-time window. If you are using a real-time search, the range marker moves to show the metric changing over time.

Gauge types

All gauge types visualize a single aggregated metric.

For example, this search aggregates error log events.

index=_internal source="*splunkd.log" log_level="error" | stats count as errors

The search can generate either of the available gauge types.


Filler gauge

A filler gauge

A filler gauge includes a value scale container that fills and empties as the current value changes. The fill level shows where the current value is on the value scale.

The current value also appears inside the filled portion of the gauge. The container appears empty for a value lower than the minimum and full for a value higher than the maximum.

Marker gauge

A marker gauge

A marker gauge shows value ranges and colors with a marker that moves to indicate the current value.

If the search generates a current value outside of the configured minimum or maximum range, the marker bounces at the lower or upper end of the value scale.

Generate a filler or marker chart

  1. Select the filler or marker chart using the visual editor by clicking the Add Chart button ( The Add Chart button in the editing toolbar. ) in the editing toolbar and either browsing through the available charts, or by using the search option.
  2. Select the chart on your dashboard so that it's highlighted with the blue editing outline.
  3. (Optional) Set up a new data source by adding a query to the Search window.
  4. To choose an existing search, close the window and select the visualization. If the Configuration panel doesn't appear, click the Configuration button ( The Configuration button in the editing toolbar. ) to bring up the Configuration panel and click +Setup Primary Data Source to choose an existing search.

Configuration Panel options for filler and marker gauges

You can use the Configuration panel to configure the following line chart components.

Title

Give your visualization a name. This is also helpful when searching for individual visualizations in the dashboard definitions. This name is not the same as the automatically assigned unique ID.

Description

Give your visualization a description to explain what the user is viewing.

Data Configurations

Choose an existing ad hoc search or create a new one.

Position & Size
You can use your mouse to change the size or location of the visualization, or the Position & Size section of the Configuration panel for pixel perfect sizing and placement.

Visualization Settings

  • Toggle the Show Value switch to show the filler value.
  • Toggle the Show Labels switch to show the value ranges of the gauge.
  • Use the Orientation buttons to choose a Vertical or Horizontal orientation.

Threshold Settings
Use the Gauge Color section to set your value ranges and their associated colors. Click the color box to select from a palette or enter a hex code, for example, #ff7189 for a shade of pink.

Background color
To change the background color of the gauge panel, click the color box to select from a palette or enter a hex code, for example, enter #FF7189 for a shade of pink.

Code
Select your visualization or its search to view and edit the source code in real-time.

Source options for filler and marker gauges

While some of these options can be set using the visual editor, there are additional options that can only be set in the source editor for viz.fillergauge. These options are added to the options field of the visualization stanza. For example, the following example shows the addition of a vertical orientation and a background color using a hex code:

"viz_25NNIqLF": {
			"type": "viz.fillergauge",
			"options": {
				"backgroundColor": "#0000FF",
                                "orientation": "vertical"
			},
			"dataSources": {
				"primary": "ds_gcEN4c7Q"
			}
		} 

To read more on how visualization stanzas are structured see: Elements of a visualization. Below are all of the options available.


Filler gauge options

The following options are available for editing filler gauges in the source editor:

Property Type Default Description
backgroundColor string light mode: "FFFFFF" dark mode: "#212527" Use a hex code to specify the color used for the dashboard background. For example: "#0000FF".
majorUnit number or "auto" auto Specify the spacing between major tick marks in pixels.
orientation string horizontal Specify the axis orientation of the gauge. horizontal or vertical.
showLabels boolean true Specify whether to display labels.
showValue boolean true Specify whether the gauge value is displayed.
usePercentageRange boolean true Specify whether to format gauge ranges as percentages.
usePercentageValue boolean false Specify whether to format the gauge values as percentages.



Marker gauge options

The following options are available for editing marker gauges in the source editor:

Property Type Default Description
backgroundColor string light mode: "#FFFFFF" Dark mode: "#212527" Use a hex code to specify the color used for the dashboard background. For example: "#0000FF".
majorUnit number or "auto" auto Specify the spacing between major tick marks in pixels.
orientation string horizontal Specify the axis orientation of the gauge. horizontal or vertical.
showLabels boolean true Specify whether to display labels.
showValue boolean true Specify whether the gauge value is displayed.
usePercentageRange boolean true Specify whether to format gauge ranges as percentages.
usePercentageValue boolean false Specify whether to format the gauge values as percentages.
ranges arrayOf(object) ["[object Object]", "[object Object]", "[object Object]"] Specify the overall range of the gauge as a series of continuous, color-coded subranges. For example, [{"from": 0, "to": 20, "value": "#4BEBA8"}, {"from": 20, "to": 50, "value": "#F4DF7A"}].

Default properties

In addition to the settings in the options field, there are two default fields that you can set. These are not options, but should be placed at the same level as the options field.

showProgressBar shows a progress bar as a visualization loads and is set to false by default. showLastUpdated shows the last time the visualization was refreshed and is set to false by default.

You can enable these features by adding the properties to a visualization, and changing the settings to true.

In the following example, the visualization will override the default for showProgressBar and show a progress bar as it loads.

	"viz_tpRnLS1I": {
		"type": "viz.fillergauge",
		"showProgressBar": true,
		"options": {
			"showSparkline": false,
			"backgroundColor": "#ffffff"
		},
		"title": "Does have a progress bar",
		"description": "Due to viz override",
		"dataSources": {
			"primary": "ds_o7IqGHcO"
		}
Last modified on 23 October, 2020
PREVIOUS
Bubble charts
  NEXT
Pie charts

This documentation applies to the following versions of Splunk® Dashboards App: 0.8.0, 0.9.0


Was this documentation topic helpful?

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters