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>