Status Indicator

Status Indicator

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Simple XML for status indicators

Custom visualizations use a namespaced syntax for Simple XML. Specific visualization properties are appended to the app and visualization context.


Add a status indicator to a dashboard panel

You can add a status indicator to a dashboard panel using Simple XML. Use this syntax to specify the app and visualization context.

<viz type="status_indicator_app.status_indicator">
</viz>

Configure status indicator properties

To configure a status indicator property, add any of the following property names and a value to this syntax.

<option name=
    "status_indicator_app.status_indicator.[property_name]">[property_value]
</option>


Option name Accepted values Default Example
showOption Number 3
<option name="status_indicator_app.status_indicator.showOption">5</option>
icon [ fix_icon | field_value] fix_icon
<option name="status_indicator_app.status_indicator.icon">field_value</option>
fixIcon Any fontAwesome icon name warning
<option name="status_indicator_app.status_indicator.fixIcon">exclamation-circle</option>
useColors [ true | false] true
<option name="status_indicator_app.status_indicator.useColors">false</option>
colorBy [ static_color | field_value] static_color
 <option name="status_indicator_app.status_indicator.colorBy">field_value</option>
staticColor Any valid CSS color string. #555
 <option name="status_indicator_app.status_indicator.staticColor">#545</option>
precision A number between 0 - 4 to indicate level of decimal precision 0
 <option name="status_indicator_app.status_indicator.precision"> 2</option>

Example Simple XML source

Here is an example dashboard panel.

  <dashboard>
  <label>Status indicator Example</label>
  <row>
    <panel>
      <title>Status indicator example dashboard</title>
      <viz type="status_indicator_app.status_indicator">
        <search>
          <query>index=_internal | stats count</query>
          <earliest>@w0</earliest>
          <latest>now</latest>
        </search>
        <option name="status_indicator_app.status_indicator.useColors">true</option>
        <option name="status_indicator_app.status_indicator.colorBy">field_value</option>     
      </viz>
    </panel>
  </row>
</dashboard>
Last modified on 03 January, 2020
PREVIOUS
Add a status indicator to a dashboard
  NEXT
Release notes

This documentation applies to the following versions of Status Indicator: 1.0.0, 1.1.0, 1.2.0, 1.3.0, 1.4.0, 1.5.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