Splunk® Enterprise

Dashboards and Visualizations

Download manual as PDF

Download topic as PDF

Use trellis layout to split visualizations

Trellis layout lets you split search results by fields or aggregations and visualize each field value separately.

This is a single value visualization with trellis layout applied. It splits customer purchase results by product category values. Users can see how the purchase metric varies for different product types.

Trellis layout example screenshot.png

Use cases

Use trellis layout to make value differences in a given data dimension more visible.

Highlight outlying values

Trellis layout can help to make outlying field values more noticeable.

For example, your dashboard users might want to track status across multiple servers in a network. A single value visualization with trellis layout can show the status of multiple servers at once. Servers with unusual status values stand out.

Compare trends for a specific metric

You can split search results so that it is easier to compare different field values visually.

For example, you can apply trellis layout to a bar chart showing recent customer activity for different product types. Splitting on the customer action field lets you scan variations in purchase frequency across different product types.

Monitor multiple resources with one search

Trellis layout can be helpful if you want to monitor multiple resources without creating and running multiple searches or generating multiple visualizations. You can use one search to generate metrics for each resource in a category or group and then split the visualization on the field that you are tracking.

Data formatting for trellis layout

You can use trellis layout to split your search results on a field. You can also split results on an aggregation if your search includes two or more aggregations, such as a count or sum.

Before you enable trellis layout, consider the comparisons or trends that you want to provide at a glance. Make sure that your search results include the fields or aggregations that represent these values.

Generating split fields

To use trellis layout, make sure that your search results include the field that you want to use for splitting the visualization. The split field is additional to any fields that you might need to generate the visualization without trellis layout. For example, you can generate a single value visualization using the following search.

index=_internal | stats count

To use trellis layout, adjust the search to generate an additional field for splitting the visualization.

index=_internal | stats count by sourcetype

You can split the single value on the sourcetype field to show a count for each sourcetype in your search results.

Use additional fields to add insight

Depending on your use case, you can generate multiple result fields to add further data dimensions to each visualization segment.

As an example, you can aggregate recent retail website data by customer action and product type. With these fields in your search results, you can use one of them to split the visualization. Users can use the split visualizations to compare customer actions across product types or see how product types relate to customer actions.

For more information on creating searches, see Statistical and charting functions in the Search Reference.

Access the trellis layout menu

You can access the trellis layout menu when creating a visualization or editing a visualization in a dashboard.

Trellis layout is not available for table visualizations or cluster maps.

Access the menu from a visualization

If you are building a visualization on the Search page, you can access the Trellis configuration menu on the Visualization tab.

Trellis layout access from search.png

Access the menu from a dashboard

  1. From a dashboard, click Edit to open the dashboard editor.
  2. Find the panel where you want to apply trellis layout.
  3. Click the "More actions" icon and select Trellis.
    Trellis UI option access.png

Configure trellis layout

The trellis layout menu lets you select "Split by" result fields or aggregations and configure segments.

Select a split field or aggregation

When you split the visualization by a field or aggregation, a separate visualization segment appears for each value in the selected field.

Result fields generated with the eval command appear in the aggregations list.

If you do not see the split field or aggregation that you want to use in this list, adjust the search to make sure that it generates the field in your search results. You might need to adjust your search to return additional fields that are not necessary for generating the visualization without trellis layout.

Adjust segment size

Select one of the segment size options. Segment size affects panel data density. Panels can show more small sized segments at once. Larger segments can help users make more detailed visual comparisons depending on the number of segments.

Small segments
Trellis layout small segment example.png

Large segments
Trellis layout large segment example.png

Configure scale sharing

The trellis layout menu includes a scale sharing option for the following visualization types.

  • Line and area charts
  • Bar and column charts
  • Choropleth map


Select "Shared" to use the same axis or legend value ranges in all segments. Select "Independent" to use axis or legend value ranges scaled for the values in each segment.

Segment formatting and appearance

Use the Format menu or Simple XML to configure visualization segment appearance. Format a visualization with trellis layout in the same way that you format a visualization without trellis layout. Each segment gets the format configurations that you apply.

Choropleth map scroll and zoom

In Choropleth maps with trellis layout, you might need to scroll and zoom a segment to focus it on a specific location. Limit scrolling and zooming to one segment to avoid triggering display changes in other segments. After focusing this segment, open the Format menu and click "Populate with current map settings" to update the focus in all segments.

Trellis layout and dashboard display

Segment density

The number of segments that trellis layout generates varies according to the number of split field or aggregation values in your search results. Dashboard panels might include a scroll bar if there are too many visualization segments to show at once.

Trellis layout scroll illustration.png

Use the Trellis menu to adjust the segment size and show more segments in the panel. You can also use the dashboard editor to drag the panel size or change the panel height option in Simple XML.

To change the order in which segments appear, adjust the search to sort or change search result order.

Panel and row best practice

Separate panels using trellis layout into their own dashboard rows. Displaying additional content in the same row can constrain trellis layout content and make the dashboard difficult to scan.

Avoid Best practice
Additional panels in the same row constrain display.

Trellis dashboard display best practice dont.png

Put the panel with trellis layout in its own row.

Trellis dashboard display best practice do.png

Drilldown in trellis layout

Use the drilldown editor or Simple XML to enable and configure drilldown. After you apply Trellis layout to a visualization, drilldown is available in each visualization segment.

Drilldown options

Typical drilldown actions, such as linking to a search or an external URL, are available for visualizations using Trellis layout. Depending on the behavior that you want, you can configure drilldown to capture and use details from the element and the visualization segment that a user clicks.

Example

This drilldown links to a search. By default, the secondary search modifies the original search to include field values from the clicked segment.

For example, trellis layout splits a retail activity visualization by customer action. if a user clicks the "ARCADE" category column in the "purchase" customer action segment, a secondary search using these field values opens.

Clicked visualization segment and column
Trellis drilldown example click.png

Search generating the visualization

...| stats count by action, categoryId | rename categoryId as "category"

Drilldown search

...| action=purchase | rename categoryId as "category" | search category=ARCADE

Predefined tokens for trellis split fields

If your trellis layout splits on a search result field, you can use the trellis.name and trellis.value predefined tokens to access the split field name and value from a clicked visualization segment.

You can pass these values to a drilldown target, such as a form or external URL. This example drilldown links to an external retail website, using the trellis.value token to pass in the product field value from the clicked segment.

<drilldown>
<link>
  http://buttercupgames.com?product=$trellis.value$
</link>
</drilldown>

Aggregations are not available in predefined tokens.

Limitations

  • Fields generated with the eval command appear as aggregations in the trellis layout configuration menu.
  • Trellis layout is not available for table visualizations or cluster maps.
  • A predefined token is not available for aggregations used for splitting a visualization.
  • Visualizations using trellis layout do not render in dashboard PDFs.

Configure trellis layout in Simple XML

Use the following Simple XML options to configure trellis layout.

Option name Type Default Description
trellis.enabled Boolean 0 Enable or disable trellis layout. Defaults to 0 (disabled).
trellis.scales.shared Boolean 1 Indicate whether to to share scale for axes in line, area, column, and bar charts or value ranges in Choropleth map segments. Use one of the following values.
  • 1: Shared scales
  • 0: Independent scales
trellis.size String medium Configure the visualization segment size. Segment size affects panel display density for the split visualization. Use one of the following values.
  • small
  • medium
  • large
trellis.splitBy Result field name N/A Indicate the search result field or aggregation name to use for splitting the visualization. Segments appear for each value in this field.

Example

Research sales trends

An analyst for an online retailer researches customer actions by product category. They use the following search to find recent customer action events by product category.

source=recent_sales_data action != NULL
| rename categoryId as "category"
|  chart count by category, action

The search generates the following column chart, showing customer actions across all product categories.

Trellis example chart before split.png


The analyst can use trellis layout to split the visualization into separate column charts for each customer action category. Trellis layout lets the analyst compare trends in the product types associated with each action.

Trellis visualization customer actions example.png

PREVIOUS
Cluster maps
  NEXT
Dashboard overview

This documentation applies to the following versions of Splunk® Enterprise: 6.6.0, 6.6.1, 6.6.2


Comments

The sort command issue is SPL-142769

Frobinson splunk, Splunker
June 28, 2017

After looking into the issue, our engineering team has filed a bug for the sort command issue you are reporting. It is listed in our known issues page for the 6.6.0 release. Please check there for further updates.

Frobinson splunk, Splunker
June 28, 2017

Hi Ehartvm,
I'll follow up with you via email.

Frobinson splunk, Splunker
June 23, 2017

This is my code right now:
index=dummy priority=2 OR priority=10
| stats count by host
| sort 6 -count

This gives me a table with two rows: the top 6 hosts and the event count for each host.
The column and bar charts will be sorted in descending order, based on the count.
The same doesn't work if I'm using the Trellis Feature and "Single Value" or "Radial Gauge".
The split is caused by host, so as you suggested, I tried the following:
index=dummy priority=2 OR priority=10
| stats count by host
| sort 6 -host
but that just sorts the underlying tables row "host" alphabetically, as expected.

Ehartvm
June 22, 2017

HI @Ehartvm,
You might need to try sorting on the field that you are using to split the visualization, rather than sorting on the "count" field.

Hope this helps!

Frobinson splunk, Splunker
June 22, 2017

How exactly would the sorting mechanism work? I'm using Trellis to split a search into multiple single-value visualizations. The statistics-table can be sorted via the "| sort -count" command. But the Trellis layout isn't affected by that.

Ehartvm
June 22, 2017

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