3. VSD Template and configuration files

Previous chapter

Next chapter

The first time you use VSD, the executable creates default template files and configuration files in your home directory. These files are used on subsequent executions; this allows it to remember the statistic level you have selected, window sizes and locations, and similar details.

You can delete these file at any point, and they will be recreated from the default the next time you use VSD.

3.1 VSD Chart Templates

VSD templates specify a set of processes and statistics that together represent a useful picture of one behavior of the system. VSD is shipped with a set of predefined templates. As described under Using and Creating Templates, you can open charts on these templates, and create your own templates based on charts you have constructed.

To further customize the templates you use, you may want to edit the templates directly. The templates are stored in a text file using specific syntax. This section provides information you need if you wish to edit the template files directly.

VSD Templates File

The default templates are in the file .vsdtemplate, which is written to your home directory the first time you start up VSD.

If you delete the .vsdconfig file, then the next time VSD is started, the file will be recreated with default values.

Template Syntax

The template files are written in a formatted form that is understood by the TCL code that supports VSD.

 

Templates in the .vsdtemplate have the following form:

set vsdtemplates(TemplateName) {
        {Type {ProcessName} StatName  scale  filter  axis}
	  {Type {ProcessName} StatName  scale  filter  axis}
        ...
    }
 

for example:

set vsdtemplates(Garbage) {
        {Stn {*} PagesNeedReclaimSize 1 none y2}
        {Stn {*} ReclaimedPagesCount 1 none y2}
        {Stn {*} EpochGcCount 1 persecond y}
        {Stn {*} ReclaimCount 1 persecond y}
        {Gem+ {*Gc*} CommitCount 1 persecond y}
    }
set vsdtemplates(CacheTooSmall) {
        {Shrpc ShrPcMonitor FreeFrameCount 1 none y2}
        {+ {*} FramesFromFreeList 1 persecond y}
        {+ {*} FramesFromFindFree 1 persecond y}

}

The data for each line in each template includes:

type — One of the following:

StnShrpcGemPgsvr

‘+’ can also be used, which means that all processes that match this line spec will be combined into a single line. + can be used either standalone, meaning all process types, or added to a type name. For details on types, see the process Type..

name — Identifies the specific process by process name. You m.ay use * to match multiple process names. For more on process names, see the process Name..

stat — The name of a specific existing statistic.

scale — The number of the scale for this particular statistic. It will usually be 1. For more details on scales, seeScaling.

filter — The name of the filter, which will be one of the following:

none
persecond
persample
aggregate

For details on these filters, see Filters

axis — Either y, the left axis, or y2, the right access. Units for this statistic line are labeled on the specified side y-axis.

Once you have created or edited your template file, save the .vsdtemplates file, and use the menu item Chart > Reload Template File to load this file. If you have made syntax errors, this file will not load.

For more about VSD templates and the syntax and options available, see the VSD help under the topic “Template Syntax”.

3.2 VSD Configuration Files

VSD provides a number of configuration options, which are set by menu items in vsd. These options are recorded in platform-independent text configuration files in your home directory.

There are two configuration files that together manage the configuration parameters that control what you see on startup.

.vsdrc

This file is used by VSD to record its current configuration. VSD reads the file when it starts and writes the file when it exits.

If you delete the .vsdrc file, VSD will start with defaults from .vsdconfig or from the VSD executable. When it subsequently exists, the file will be recreated with the current settings.

You should not modify this file manually. To make changes in the way that VSD is always started, no matter how it was configured at the previous shutdown, edit the .vsdconfig file.

.vsdconfig

You can configure VSD by setting default values in this file. Any value set in .vsdconfig will override the same definition in .vsdrc.

If you delete the .vsdconfig file, then the next time VSD is started, the file will be recreated with default values.

Configuration file format

In most cases, you can configure your default display using by taking advantage of the natural way VSD saves your settings to .vsdrc and reads them on restart. By doing this, you get a consistent display without any extra work.

However, if you want to set a configuration that is always used, regardless of what you do during any particular VSD session, you will need to edit the VSD configuration file .vsdconfig. The configuration file format is the same in .vsdconfig and .vsdrc, so you may copy lines between files.

The following sections document many of the relevant configuration parameter names and meanings.

Configuration options are specified in a format that is specific to VSD/TCL, and are not intended for general use by customers.

To include a comment line, prefix the line with #.

Incorrect configuration names and settings encountered in reading the files are ignored; default values will be used in this case.

Configuration options have the format:

set vsd (configurationOption) value

for example:

set vsd(confirmonexit) 1

Acceptable value arguments depend on the parameter. Many are Integers, but some parameters are strings. Lists are indicated by {}. Boolean statistics are specified as 0 or 1.

Main Window options

The following statistics relate to the main VSD window.

Parameter name

Type

Default

Description

confirmonexit

Boolean (0 or 1)

 

1

Whether to confirm before exiting VSD, Main > Confirm Exit

def:sortbytype

Column label

Type

On file load, the column to use to sort processes.

def:sortdecreasing

Boolean (0 or 1)

1

On file load, the direction of sort for the process list; 0 is decreasing, 1 is increasing.

combineFiles

Boolean (0 or 1)

0

Whether to combine values for all selected processes in all open files when displaying a statistic; Main > Combine Across Files

combineInstances

Boolean (0 or 1)

0

Whether to combine values for all selected processes when displaying a statistic; Main > Combine

filelist

list of strings

empty list

List of filenames displayed in the Main Window File: dropdown.

noFlatlines

Boolean (0 or 1)

0

Whether to show statistics for a process if all values for that statistic are zero; Main > No Flatlines

showCtrInfo

Boolean (0 or 1)

0

Whether to have the Statistics Information window open. Main > Show Statistics Info

singleFileMode

Boolean (0 or 1)

1

Whether working with multiple data files is allowed. Main > Single File Mode

templatesUseSelection

Boolean (0 or 1)

0

Whether the template applies only to the selected processes.

Chart Window Display Options

The following parameters describe the defaults for including and omitting information from chart windows.

Parameter name

Type

Default

Description

absoluteTSMode

Boolean (0 or 1)

1

Whether to use absolute timestamps for charts. Main > Absolute Timestamps

activecolor

string

red

The color of the selected line on a chart. Chart > Selected Line Color...

def:linestyle

linear | step |

natural | quadratic

linear

How the line is rendered on charts; Chart > Default Line Style

def:showcrosshairs

Boolean (0 or 1)

0

Whether to show cursor crosshairs on charts, Chart > Show CrossHairs

def:showcurxy

Boolean (0 or 1)

1

Whether to show current X and Y values on a chart; Chart > Show Current Values

def:showgridlines

Boolean (0 or 1)

0

Whether to show gridlines on charts, Chart > Show Grid Lines

def:showlegend

Boolean (0 or 1)

1

Whether to show the legend (the process and statistic name and line color for the chart lines) on charts; Chart > Show Legend

def:showlinestats

Boolean (0 or 1)

1

Whether to show text with points, min, max, mean, and standard deviation on graph; Chart > Show Line Stats

def:showminmax

Boolean (0 or 1)

0

Whether to show max and min values on chart menu bar; Chart > Show Max and Min

def:xaxis:showtitle

Boolean (0 or 1)

1

Whether to display label on x axis, Chart > Show Time Axis Title

def:xformat

date | time | elapsed

time

How to display the time on the x-axis of a chart; Chart > Time Format

def:yaxis:showtitle

Boolean (0 or 1)

1

Whether to display y axis label on left side, Chart > Show Left Axis Title

def:y2axis:showtitle

Boolean (0 or 1)

1

Whether to display y axis label on right side, Chart > Show Right Axis Title

Monitor Window Options

The following parameters apply to the Monitor window, describing options for how to start statmonitor.

Parameter name

Type

Default

Description

wv:statmoninterval

integer

20

Monitor window, default statmonitor sample interval

wv:statmonflush

integer

0

Monitor window, number, default statmonitor flush interval

wv:statmonlevel

integer

1

Monitor window, number, default statmonitor statistics level

wv:statmonappstats

integer

0

Monitor window, number, default statmonitor number of app stats

wv:statmonsessions

list of integers

empty list

Monitor window, default for list of session ids to monitor in statmon

wv:statmonpids

list of integers

empty list

Monitor window, default for list of process ids to monitor in statmon

wv:statmoncompress

Boolean (0 or 1)

0

Monitor window, default for if statmonitor should write compressed file

Window locations and display

The location, size, and proportion of the Main Window, the Chart window, and the Statics info file are recorded.

def:geometry sets the size and location of the main window.

instancePaneSize sets the height of the Process pane in the main window.

statisticPaneSize sets the height of the Statistics pane in the main window.

geometry:.datawin sets the size and location of the chart window.

geometry:.ctrinfo sets the location of the statistics information window.

Fonts

Window title, menu, and other fonts are based on operating system default fonts, and are not controllable. However, you may set the font for text panes and for charts.

Main window text fonts

textfont is a list of font attributes that controls what is used to display text on a chart windows. This configuration is used for most text on a chart: legend, axis labels, summary information, etc. Attributes include the font family, size, weight, slant, underline and overstrike are options. These can be set using Help > Choose Text Font.... For example,

textfont {-family fixed -size 10 -weight normal -slant roman 
	-underline 0 -overstrike 0}

Chart window text fonts

smallfont is a list of font attributes that controls what is used to display text on a chart windows. This configuration is used for most text on a chart: legend, axis labels, summary information, etc. Attributes include the font family, size, weight, slant, underline and overstrike are options. These can be set using Chart > Choose Chart Font.... For example,

smallfont {-family fixed -size 12 -weight normal -slant roman 
	-underline 0 -overstrike 0}

 

Previous chapter

Next chapter