Style Guideline

This guide gives a few tips in getting the most out of your Workspaces using tips and tricks from existing Logscape Apps. Each Workspace is a maximum of 16 x 16 tiles. The tile sizing is dynamic.

On a typical display a Workspace can be 6x10 tiles without any scrolling required. Anything larger and you run the risk of the Workspace being too large for smaller displays.

Navigation and Filters

You may have noticed from the standard Logscape Apps that each Workspace has a navigation panel. The navigation panel provides links to all the other Workspaces in the App. The Navigation panel should be 4 tiles high. Here's a snippet for the html code to build the navigation panel taken from one of the apps.

<div class='appNavStyle1' >
<ul class='nav nav-stacked menu' >
<li class="active"><a href="?Workspace=Home"></i> Home </a></li>
<li><a href="?Workspace=Logscape - Data Audit" title="Data Audit"></i> Data Audit</a></li>
<li><a href="?Workspace=Logscape - System Audit" title="System Audit"></i> System Audit</a></li>
<li><a href="?Workspace=Logscape - User Audit" title="User Audit"></i> User Audit</a></li>
<li><a href="?Workspace=Logscape - Alert Audit" title="Alert Audit"></i> Alert Audit</a></li>
<li><a href="?Workspace=Logscape - Agent Audit" title="Agent Audit"></i> Agent Audit</a></li>
<li><a href=""></i> Apps</a></li>
<li><a href="?Workspace=Windows - Home"></i> Windows</a></li>
<li><a href="?Workspace=Unix - Home"></i> Unix</a></li>
<li><a href=""></i> Cloud</a></li>

The colours used for the panel and filter is a slate gray



Pie Charts

Pie charts are useful for showing relative quantities. There are few things to be aware of when you have a large number of series. If you have more than 10 series in your pie chart use the top(N) function to make sure that the legend does not flow out of the tile.

| _type.equals(oskpis) cpu.max(_hostname,) top(5)

The image below shows a typical pie chart with a manageable number of series. The pie chart has the legend enabled. Both fit comfortably in the tile.

Having long series names or too many has the following consequence. The legend takes up most of the space in the tile making the visualisation almost illegible.

If your data is uses a set number of series of 5 or less, you may choose to disable the legend and rely solely on the chart labels. Disabling the chart legend will also give you more screen real estate for your visualisation.

Aggregate and Time Series View

It is common in Logscape Apps to combine an aggregate chart type like pie chart or table and a time series view of the same data on the same row. This provides trend view of the data, showing outliers and behaviour. The aggregate view will show the general behaviour of the entire data set. Here's an example from the unix app.

The average cpu load is shown in the pie chart. The trend view is shown with a spike around 1430 on host lscape2.