Splunk® IT Service Intelligence

Modules

Download manual as PDF

Download topic as PDF

ITSI module visualizations

Module visualizations let you monitor the overall performance of your deployment, and easily share issues with other analysts on your team.

There are multiple visualization tools used for monitoring ITSI modules:

  • Service Analyzer, which can use module KPIs to give a top view to managers.
  • Glass tables, which are used to quickly show data from one or more of your services, as well as share incidents with other users.
  • Deep dives, which let users view KPI search results over time, zoom-in on KPI metrics and log events, and visually correlate root cause.

Entity Details

ITSI modules display information about an entity when you drill down from a deep dive lane in ITSI. The Entity Details page provides key metrics on entities that comprise a service.

In the context of ITSI modules, a drilldown is an action that lets you view entity inventory information (for example, vendornumber of CPU cores, total amount of RAM, OS version, etc.), entity performance metrics (for example, failover status, CPU usage, memory used, and disk space usage, etc.) and other entity-related events. You can access this information by "drilling down" from the Service Analyzer page to the Deep Dive page.

Access Entity Details page

ITSI provides a visualizations page that displays information about an entity when you drill down from a deep dive lane in ITSI. The Entity Details page provides key metrics on entities that comprise a service. The following example is from the OS Module Host Details page.

ITSI 20 OSHostDetails.png

Before you can use the Details page:

  1. Define at least one service and the entities that comprise the service.
  2. From the Service Analyzer page, click a service or a KPI.
  3. You must enable lane overlays in the service deep dive page for each KPI.
  4. In the Deep Dive page, click on a point in any of the lanes. If "No drill down option available" appears, enable overlays for the lane.
  5. Click <Entity> Details in the pop-up menu that appears.

ITSI 20 ViewOSHostDetails.png

The Details page appears.

  1. Review the charts on the page.
  2. Click the CPU, Memory, Storage, or Entity events tabs to see charts for each of these categories for the selected host entity.
  3. To see metrics for a different entity, select that entity under the Entity: menu on the left side of the page.
  4. To change the default time range (24 hours), select the time range picker under the Entity: menu and choose the time range that you want.
  5. To see the events that produced the plot in a dashboard panel, select a plot in the panel. The Search page loads and displays the events.

Modify 'mini_chart' vizualizations to work with Highcharts

In versions 2.5.0 and above of ITSI, SA-ITSI-CustomModuleViz XML files work with Highcharts. Your deployment's mini_chart will, by default, have only one color and no thresholds.

Before example

 

      <viz type="SA-ITSI-CustomModuleViz.mini_chart">
        <option name="SA-ITSI-CustomModuleViz.mini_chart.app">DA-ITSI-OS</option>
        <option name="SA-ITSI-CustomModuleViz.mini_chart.id">os-disk-usage</option>
        <option name="SA-ITSI-CustomModuleViz.mini_chart.title">Total Storage Used (%)</option>
        <option name="SA-ITSI-CustomModuleViz.mini_chart.subtitleField">used_space</option>
        <option name="SA-ITSI-CustomModuleViz.mini_chart.chartType">markerGauge</option>
        <option name="SA-ITSI-CustomModuleViz.mini_chart.search">
            <![CDATA[
            | savedsearch DA-ITSI-OS-Context_Chart_Disk_Usage_Search host="$host$"
            ]]>
        </option>
        <option name="SA-ITSI-CustomModuleViz.mini_chart.charting_chart_rangeValues">[0,75,90,100]</option>
        <option name="SA-ITSI-CustomModuleViz.mini_chart.charting_gaugeColors">["0x81CE70","0xFFEB68","0xAC0000"]</option>
        <search>
          <query>|noop | stats count</query>
        </search>
      </viz>	  

After example

 

      <viz type="SA-ITSI-CustomModuleViz.mini_chart">
        <option name="SA-ITSI-CustomModuleViz.mini_chart.app">DA-ITSI-OS</option>
        <option name="SA-ITSI-CustomModuleViz.mini_chart.id">os-disk-usage</option>
        <option name="SA-ITSI-CustomModuleViz.mini_chart.title">Total Storage Used (%)</option>
        <option name="SA-ITSI-CustomModuleViz.mini_chart.subtitleField">used_space</option>
        <option name="SA-ITSI-CustomModuleViz.mini_chart.chartType">solidgague</option>
        <search>
		  <query>| savedsearch DA-ITSI-OS-Context_Chart_Disk_Usage_Search host="$host$"</query>
        </search>
      </viz>	  

Customize your mini_chart visualizations using Highchart

Use the <option name="SA-ITSI-CustomModuleViz.mini_chart.charting_ to customize your mini_chart visualizations to any option that is valid in Highcharts.

  1. To change your background color, add the <option name="SA-ITSI-CustomModuleViz.mini_chart.charting_chart_backgroundColor">COLOR</option> line to your XML file.
  2. Change the COLOR color to your preferred color. Example: <option name="SA-ITSI-CustomModuleViz.mini_chart.charting_chart_backgroundColor">#FFFFE0</option>
  3. To change your x-axis line color, add the <option name="SA-ITSI-CustomModuleViz.mini_chart.charting_xAxis_lineColor">COLOR</option>
  4. Change the COLOR to your preferred color. Example: <option name="SA-ITSI-CustomModuleViz.mini_chart.charting_xAxis_lineColor">black</option>

See the below example to view a visualization with a defined background color and x-axis color.

Highchart API example Modules.png

Note: The chart will not render if you add an invalid value to your option line. See the list of visualization options in the Highchart API documentation for more information.

Set color ranges based on data value

Use Highcharts to add colors to your charts, or build a multi-colored chart based on data values.

Add color ranges for solidgauge or gauge charts

  1. Identify the stops in your chart. Identify the stops in your chart by assigning a float between 0 and 1 for each tuple in your array. This assigns a relative position in each gradient. Examples in bold: <option name="SA-ITSI-CustomModuleViz.mini_chart.charting_yAxis_stops">[["0.2", "green"], ["0.5", "yellow"], ["0.85", "red"]]</option> The above example will set three stops at 20%, 50% and 85% of the range of solidgauge.
  2. Assign a color to each tuple in your array. Examples in bold: <option name="SA-ITSI-CustomModuleViz.mini_chart.charting_yAxis_stops">[["0.2", "green"], ["0.5", "yellow"], ["0.85", "red"]]</option>
  3. Review the completed example: <option name="SA-ITSI-CustomModuleViz.mini_chart.charting_yAxis_stops">[["0.2", "green"], ["0.5", "yellow"], ["0.85", "red"]]</option>

Add color ranges for column, line, or area charts

  1. Identify the color ranges for your chart. Identify which colors you want to apply to your chart, and in what order.
  2. Add the following option for color ranges: <option name="SA-ITSI-CustomModuleViz.mini_chart.charting_plotOptions_series_zones">[{"value": "200","color": "red"},{"color": "green"}]</option>. The above value is an array of zones. It will make all the part of the chart up to 200 the color red, while all higher values will be green.
PREVIOUS
Install and configure ITSI modules
  NEXT
ITSI module performance and sizing guidelines

This documentation applies to the following versions of Splunk® IT Service Intelligence: 3.0.0, 3.0.1, 3.0.2, 3.1.0, 3.1.1, 3.1.2, 3.1.3, 3.1.4, 4.0.0, 4.0.1, 4.0.2, 4.0.3, 4.0.4, 4.1.0, 4.1.1, 4.1.2, 4.1.5, 4.2.0, 4.2.1, 4.2.2, 4.2.3, 4.3.0, 4.3.1, 4.4.0, 4.4.1


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