Related Answers
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.4.9, 6.4.10, 6.4.11, 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.5.6, 6.5.7, 6.5.8, 6.5.9, 6.5.10, 6.6.0, 6.6.1, 6.6.2, 6.6.3, 6.6.4, 6.6.5, 6.6.6, 6.6.7, 6.6.8, 6.6.9, 6.6.10, 6.6.11, 6.6.12, 7.0.0, 7.0.1, 7.0.2, 7.0.3, 7.0.4, 7.0.5, 7.0.6, 7.0.7, 7.0.8, 7.0.9, 7.0.10, 7.0.11, 7.0.13, 7.1.0, 7.1.1, 7.1.2, 7.1.3, 7.1.4, 7.1.5, 7.1.6, 7.1.7, 7.1.8, 7.1.9, 7.1.10, 7.2.0, 7.2.1, 7.2.2, 7.2.3, 7.2.4, 7.2.5, 7.2.6, 7.2.7, 7.2.8, 7.2.9, 7.3.0, 7.3.1, 7.3.2, 8.0.0, 7.3.3, 8.0.1
Feedback submitted, thanks!