Splunk® IT Service Intelligence

User Manual

Download manual as PDF

Download topic as PDF

Build and edit beta glass tables in ITSI

Don't confuse the beta glass table editor with the classic glass tables you've already built. Beta glass tables say beta in the version column. If you're editing an original glass table, see Create a glass table in ITSI.

Create a glass table in the beta editor to test out the new editing experience and provide feedback for future versions. Glass tables help you visualize and monitor the interrelationships and dependencies across your IT and business services. You can add metrics like KPIs, ad hoc searches, and service health scores that update in real time against a background that you design.

You can also install the Content Pack for Example Glass Tables to get preconfigured beta glass tables directly into your ITSI environment. For more information, see About the Content Pack for Example Glass Tables.

Customize your glass table canvas

The canvas is the graphical grid area where you build out your glass table visualization. The canvas is different than the glass table background. Only parts of your glass table that are within the canvas (grid area) are displayed to users. You can preview your glass table without saving or losing your changes by clicking View.

Customize your glass table canvas in the following ways:

  1. Change the canvas size
  2. Upload a background image
  3. Change the background color

Change the canvas size

The beta glass table canvas has default dimensions of 1920 x 1080 pixels. This is conceptually different than the current glass table editor, which has an infinite canvas.

  1. (Optional) In the Configuration panel, change the Display Mode.
    • Select Actual Size to display the actual size in pixels.
    • Select Fit to Width so the canvas takes up the entire window and applies to both edit mode and view mode. The canvas fits horizontally but might still require vertical scroll.
  2. Manually change the dimensions of the canvas, in pixels, using the Canvas Width and Canvas Height fields.
  3. Click saveSave icon.to save your changes.

Below are some popular examples of standard canvas sizes:

  • Monitors. 16:9 aspect ratio resolutions such as: 1280 x 720 (HD), 1920 x 1080 (FHD), 2560 x 1440 (4K)
  • U.S. letter. 4:3 aspect ratio resolutions such as: 640 x 480, 900 x 600
  • Some mobile phones. 18:9 aspect ratio resolutions such as: 2880 x 1440

Change the background color

  1. Click the glass table canvas grid.
  2. In the Configuration panel, choose a background color. Either enter the hex code for a color, such as #ffff00, or choose a color from the palette.

    The background color is applied to the bottom canvas layer while background images are placed one layer above. If you've added a background image to your glass table, only portions of the canvas that are not covered by the image are visible in the designated color.

  3. Click saveSave iconwhen you're finished.

Upload a background image

You can upload a background image to further customize your glass table. Supported image types are PNG, JPG/JPEG, and GIF.

By default, uploaded background images are positioned at (0,0) on your glass table canvas. This means that the top left corner of the uploaded image is at the top left corner of the canvas. Increasing the y-axis values moves the image down, while increasing the x-axis values moves the image to the right.

  1. In the Background Image section of the Configuration panel, drop your image file or click browse... to select it. You can also specify a URL for web-based images. If you use web-based images, the image is updated each time you refresh your glass table.
  2. Configure the sizing options to fit your individual needs:
    • Select Contain (default) to fit the entire image to the canvas width. The canvas height might not be completely covered.
    • Select Cover to cover the entire canvas. The entire background image might not be displayed if the height to width ratio of the image is different than the height to width ratio of the canvas.
    • Select Custom to position the image on the x-axis and y-axis and to change the width and height, in pixels.
    • Select Original Size to display the image with its original dimensions.
  3. Click View to see the image as it will appear in the glass table.
  4. Click saveSave iconwhen you're finished.

Add and edit a custom icon

You can add custom icons to the icon gallery as long as they are in SVG format.

  1. In the editing toolbar, click the icon button A button with four shapes. .
  2. Drop your image or click browse... to add it to the icon gallery.
  3. Click the the icon to add it to your glass table.
  4. (Optional) Provide a title and description for the icon. These fields show up in both Edit and View mode.
  5. Change the icon color and opacity on the Configuration panel.

If you upload a multi-colored icon, the original colors are retained in the gallery but you cannot recolor in multi-color. For example, if you upload a red and black icon, you cannot change red to blue and black to green. If you want to change the color, you must choose a single color.

Uploaded icons remain in the KV store so you can use them again later. To delete an icon from the icon gallery, click the X that appears when you hover over it.

Add and edit text

You can add custom text to your glass table.

  1. While in edit mode, click the text button Button with a lower case A and an upper case A. in the editing toolbar.
  2. In the Font Settings section of the Configuration panel, choose a font, size, and color.
  3. Click saveSave icon.to save your changes.

Create and customize shapes

Use the glass table toolbar to add shapes to your glass table. You can add ellipses, lines, and rectangles. Use the Styling tab in the editing panel tab to format your shapes.

  1. On the editing toolbar, click the shapes buttonSquare button with a small arrow in the right corner.
  2. Select a shape to add it to the glass table.
  3. (Optional) Provide a title and description for the shape. These fields show up in both Edit and View mode.

Connect a shape to a data source

You can connect a shape to a specific data source, such as a KPI or service health score, so that the shape's color changes based on the status of that metric. Because thresholding for shapes is currently unavailable in the UI, you need to first add the metric as a single value visualization and then change it to a shape in the source editor.

You cannot currently connect lines to data sources. Only ellipses and rectangles are supported.

  1. Create a single value visualization for the data source you want to use. For instructions, see Add a KPI visualization and Add an ad hoc search visualization.
  2. If you're using an ad hoc search, configure thresholds as needed. For instructions, see Configure thresholds.
  3. Click Source to open the glass table JSON source code editor.
  4. Locate the visualization you just added and change viz.singlevalue to viz.rectangle (for rectangles) or viz.ellipse (for circles).
  5. Click Back to return to the glass table canvas and ensure that the shape's color matches the current severity of the metric.

For more information about using the source editor, see Edit your beta glass table using the source editor.

Clone, layer, and delete objects

When you select a visualization or shape, a panel appears on the object.

A KPI visualization is selected and has a panel on the right of it with three options. The first option is the layer option, the second option is the clone option, and the third option is the delete option.

Perform the following actions on an object:

  • Layer the object.
  • Clone the object. If you clone an object that is connected to a data source, you must connect the clone manually.
  • Delete the object.

Add a KPI visualization

Add a KPI visualization to display the associated search values. The KPIs continuously update in real-time according to the search schedule that you define when you create the search. By default, KPIs are represented by single value visualizations with a sparkline.

  1. Click the data iconData icon.to display the services available in your IT environment. Only services you have permission to read are listed.
  2. Expand a service to view its KPIs.
  3. Select a KPI to add it as a visualization.
  4. Use the Configuration panel to customize the visualization:
    • Change the visualization type to single value or gauge.
    • Enable Show Trending Value to display a trending arrow comparing the current value to the previous one.
    • For Trend Display as, specify whether the trend value is displayed as an absolute count or a percentage of how much the last value changed in comparison with the current one.
    • Enable Show Sparkline to show the single value sparkline that displays time-based trends.
    • Under Number Formatting, change the Data Precision to specify the number of decimal places to display. For example, to display 3 decimal places, use a value of 3. The maximum value is 20.
    • Under Number Formatting, add a Unit to specify the label text to show next to the single value. Specify whether the unit label should appear before or after the single value.
  5. Click saveSave icon.when you're finished.

Add an ad hoc search visualization

Create a custom visualization to display search results based on an ad hoc search. Your custom search must include the timechart command or stats by _time to use thresholding.

The results of your ad hoc search must include the field alert_value. Otherwise, ITSI picks the first column instead and you'll see values like #FF7492 rather than your actual search results.

  1. Click the data iconData icon.to display the services available in your IT environment. Only services you have permission to read are listed.
  2. Click Create Ad hoc Search.
  3. Provide a data source name and enter a search. For example, index=_internal | timechart count.
  4. Select the time range for the search.
  5. Click Run & Save. The search is added to the list of ad hoc searches.
  6. Click the ad hoc search to add it to the glass table.
  7. Use the Configuration panel to customize the visualization:
    • Change the visualization type if desired.
    • Enable Show Trending Value to display a trending arrow comparing the current value to the previous one.
    • For Trend Display as, specify whether the trend value is displayed as an absolute count or a percentage of how much the last value changed in comparison with the current one.
    • Enable Show Sparkline to show the single value sparkline that displays time-based trends.
    • Threshold Settings are currently unsupported for ad hoc search visualizations.
    • Under Number Formatting, change the Data Precision to specify the number of decimal places to display. For example, to display 3 decimal places, use a value of 3. The maximum value is 20.
    • Under Number Formatting, add a Unit to specify the label text to show next to the single value. Specify whether the unit label should appear before or after the single value.
  8. Click saveSave icon.when you're finished.

Add a chart or table visualization

Add a chart visualization to show one or more data dimensions in a results set. Add a table to visualize patterns for one or more metrics across a data set.

  1. Click the chart iconChart iconand select a chart type.
  2. (Optional) Provide a title and description for the visualization. These fields show up in both Edit and View mode.
  3. Provide a data source name and a search query to generate results in the correct format for the visualization you're building. For information and examples, see Data structure requirements for visualizations in the Dashboards and Visualizations manual.
  4. Click Source and use the source editor to further configure your visualization. While you can add some visualizations from the glass table editor, all configuration options must be set in the source editor. For information, see Edit your beta glass table using the source editor.
  5. Click saveSave icon.when you're finished.

See also:

Configure drilldowns

You can drill down from a KPI visualization or a shape to a custom URL.

  1. Select the object you want to drill down from.
  2. In the Configuration panel, click Add Drilldown.
  3. For On Click, choose Link to custom URL.
  4. Provide a relative or absolute URL.

    If you don't provide an http:// address, the generated URL is considered internal to ITSI and uses a localhost URL, for example localhost:8000//. If you provide an http:// prefix (for example, http://splunk.com), the drilldown directs to that external URL.

  5. (Optional) Select Open in new tab so the drilldown link opens in a new tab.
  6. Click Save.
  7. Click View to enter view mode and test the link. If drilling down from a KPI visualization, you must click the actual value in the visualization, not just anywhere on the visualization, in order to go to the link.

Configure thresholds

Configure thresholds on a single-value or single-value radial visualization to determine its color, which indicates the current status of the metric. Assign a color to numerical ranges of metric values.

You can only configure thresholds for ad-hoc search visualizations. KPI and service health score visualizations reflect the thresholds configured in the service definition. You cannot modify these thresholds in the glass table editor. For more information, see Set aggregate threshold values in the Administer Splunk IT Service Intelligence manual.

  1. In edit mode, select the ad-hoc visualization for which you want to configure thresholds.
  2. In the Configuration panel, expand Threshold Settings.
  3. Toggle Threshold to enable thresholding for the visualization.
  4. Configure the colors you want the visualization to be when the metric value reaches certain limits. The color is meant to indicate the current status of the metric.
    GThresholds.png

Set different time ranges for visualizations

By default, the global time range picker on a beta glass table sets the time for all visualizations. However, you can add additional inputs to set different time ranges for multiple visualizations. For example, you might leverage this functionality if you want to view one KPI for the past hour, and compare those results to a different KPI over the past day.

  1. Add your visualizations to the glass table. For instructions, see Add a KPI visualization and Add an ad hoc search visualization.
  2. Click saveSave icon.before entering source mode to make sure you don't lose any work.
  3. Click Source to edit the XML source code directly.
  4. To add a new time picker, copy the JSON blob for the global picker that already exists under inputs and give it a different name and token.
  5. Add the name of the new new time range picker under globalInputs in the layout section.
  6. Update one of the visualizations to use the token of the time range picker you just added.
  7. Click Back to return to the glass table editor. Verify that updating the time range for one of the time pickers only updates the corresponding visualization and not all visualizations.

For more information about using the source editor, see Edit your beta glass table using the source editor.

Example

The following code sample shows how to add an additional time picker to a glass table. The new time picker is called otherTime and its token is otherT:

{
	"visualizations": {
		"viz_mYyk8UA5": {
			"options": {},
			"dataSources": {
				"primary": "ds_UXEaDW7w"
			},
			"title": "Viz 1",
			"type": "viz.singlevalue"
		},
		"viz_jbiEWOGc": {
			"options": {},
			"dataSources": {
				"primary": "ds_VKYi2Qrj"
			},
			"title": "Viz 2",
			"type": "viz.singlevalueradial"
		}
	},
	"inputs": {
		"otherTime": {
			"options": {
				"defaultValue": "-60m, now",
				"token": "otherT"
			},
			"type": "input.timerange"
		},
		"globalTime": {
			"options": {
				"defaultValue": "-60m, now",
				"token": "TimeRange"
			},
			"type": "input.timerange"
		}
	},
	"description": "",
	"dataSources": {
		"ds_UXEaDW7w": {
			"options": {
				"queryParameters": {
					"earliest": "$TimeRange.earliest$",
					"latest": "$TimeRange.latest$"
				},
				"refreshType": "delay",
				"query": "<your_SPL_search_>",
				"refresh": 60
			},
			"meta": {
				"serviceID": "95c99846-404f-4c92-9923-2a8c8594bff1",
				"kpiID": "SHKPI-95c99846-404f-4c92-9923-2a8c8594bff1"
			},
			"name": "Buttercup Store - ServiceHealthScore",
			"type": "ds.search"
		},
		"ds_VKYi2Qrj": {
			"options": {
				"queryParameters": {
					"earliest": "$otherT.earliest$",
					"latest": "$otherT.latest$"
				},
				"refreshType": "delay",
				"query": "<your_SPL_search_>",
				"refresh": 60
			},
			"meta": {
				"serviceID": "97646b7f-9c38-4d8d-839a-f32fd1c7443a",
				"kpiID": "SHKPI-97646b7f-9c38-4d8d-839a-f32fd1c7443a"
			},
			"name": "Application Performance - ServiceHealthScore",
			"type": "ds.search"
		}
	},
	"title": "<Glass table title>",
	"layout": {
		"options": {
			"height": 1080,
			"width": 1920,
			"backgroundColor": "#FFFFFF"
		},
		"globalInputs": [
			"globalTime",
			"otherTime"
		],
		"structure": [
			{
				"position": {
					"h": 210,
					"y": 150,
					"w": 300,
					"x": 100
				},
				"item": "viz_mYyk8UA5",
				"type": "block"
			},
			{
				"position": {
					"h": 220,
					"y": 160,
					"w": 290,
					"x": 570
				},
				"item": "viz_jbiEWOGc",
				"type": "block"
			}
		],
		"type": "absolute"
	}
}
Last modified on 12 March, 2020
PREVIOUS
Overview of the beta glass table editor in ITSI
  NEXT
Beta glass table keyboard shortcuts in ITSI

This documentation applies to the following versions of Splunk® IT Service Intelligence: 4.4.0, 4.4.1, 4.4.2, 4.4.3


Was this documentation topic helpful?

Enter your email address, and someone from the documentation team will respond to you:

Please provide your comments here. Ask a question or make a suggestion.

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