Splunk® Enterprise

Developing Views and Apps for Splunk Web

Download manual as PDF

Download topic as PDF

Custom visualizations in Simple XML

Include custom visualizations in Simple XML dashboards.

Guidelines

Add a custom visualization to a panel

Use the app name and visualization name for the <viz> type value.

To add a custom visualization to a dashboard panel, indicate the visualization using the following syntax.

<viz type="[app_name.viz_name]">
...
</viz>

For example, add the sample_viz custom visualization to a dashboard panel.

<viz type="viz_sample_app.sample_viz">
...
</viz>


Configure visualization properties in Simple XML

Users can specify Simple XML option values for any visualization properties using this syntax:

<option name="[app].[visualization_name].[property_name]">[specified_value]</option>

For example, specify a maximum value for a custom visualization using this option. In this case, the app name is viz_sample_app and the visualization name is sample_viz.

<option name="viz_sample_app.sample_viz.maxValue">200</option>

Example Simple XML

This example shows how to include and configure a custom visualization in a Simple XML dashboard panel.

In this example, the custom visualization app name is viz_sample_app and the visualization name is sample_viz.

<dashboard>
  <label>Sample</label>
  <row>
    <panel>
      <viz type="viz_sample_app.sample_viz">
        <search>
          <query>index=_internal | stats count</query>
        </search>
        <option name="viz_sample_app.sample_viz.maxValue">200</option>
        <option name="viz_sample_app.sample_viz.minValue">0</option>
      </viz>
    </panel>
  </row>
</dashboard>

PREVIOUS
Design guidelines
  NEXT
Custom visualizations in SplunkJS

This documentation applies to the following versions of Splunk® Enterprise: 6.4.0, 6.4.1, 6.4.2, 6.4.3, 6.4.4, 6.4.5, 6.4.6, 6.4.7, 6.4.8, 6.5.0, 6.5.1, 6.5.1612 (Splunk Cloud only), 6.5.2, 6.5.3, 6.5.4, 6.5.5, 6.6.0, 6.6.1, 6.6.2


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