VCacheMonitor(1)

Name

VCacheMonitor - monitor the state of the Vesta-2 function cache

Synopsis

VCacheMonitor [ -update time ] [ -ts time ] [ -n num ] [ -rows num ]

Contents

Description

VCacheMonitor is a client application for monitoring the state of a running Vesta-2 function cache.

The program starts by printing information that identifies the function cache, including:

The program then prints status lines describing various aspects of the cache state. See the Fields section below for descriptions of each of the fields on a status line.

If VCacheMonitor is unable to contact the function cache it was monitoring, it prints an error message and continues to poll the function cache until a connection can be re-established. Once it is able to contact the cache again, it resumes monitoring where it left off.

Switches

Prefixes of switch names are recognized. For example, "-u" can be used instead of "-update".

-update time
By default, a new status line is printed every 10 seconds. If -update is specified, then a new line is printed every time seconds. time must be a non-negative integer. To specify an update time in units other than seconds, time can end with one of the following unit identifiers: m (minutes), h (hours), and d (days).

-ts time
If -ts is specified, a timestamp is printed every time seconds. By default, timestamps are never printed. To specify a timestamp interval in units other than seconds, time can end with one of the following unit identifiers: m (minutes), h (hours), and d (days).

-n num
By default, VCacheMonitor prints status lines indefinitely. If -n is specified, then only num status lines are printed.

-rows num
By default, VCacheMonitor prints the column headings once at the start of the program. If you specify -rows num, then new heading columns are printed every num status lines.

-check
By default, VCacheMonitor prints the number of requested status lines and then exits with status 0. If -check is specified, it will only attempt to print one line. If it was able to successfully contact the cache and print the line it will exit with status 0. If there was an error in reaching the cache or getting its status, it will exit with status 1.

Fields

Each status line contains the following fields:

SIZE
The size of the function cache image (in bytes).

RES
The size of the function cache image resident in physical memory (in bytes).

FREE VARS
LOOK UP
ADD ENT
The number of calls to the function cache's FreeVariables, Lookup, and AddEntry methods since the last status line was printed. These values are indicative of the load on the function cache. Since the values of these fields are relative to the previous status line, no values are printed for them on the first status line.

NUM VMPK
The number of volatile MultiPKFile objects in memory.

NUM VPKS
The number of volatile PKFile objects in memory.

NUM ENTS
The total number of entries in the cache (both in memory and on disk in the stable cache).

NEW ENTS
The number of new cache entries in memory. These entries have not been written to the stable cache.

NEW PKLS
The total size of the pickled values associated with the new entries of the previous field.

OLD ENTS
The number of "old" cache entries in memory. These are all entries that reside in the stable cache, but have been "paged in" for efficiency.

OLD PKLS
The total size of the pickled values associated with the "old" entries of the previous field.

NUM HF
The number of entries in the function cache's hit filter. These are entries that may soon be or are currently being deleted. This value is non-zero only if a weed is in progress.

NUM DEL
The number of cache entries currently being deleted. This value is non-zero only if a weed is in progress.

MPK WEED
The number of MultiPKFiles that must still be processed as part of a weed.

Configuration Variables

Like most Vesta-2 applications, VCacheMonitor reads site-specific configuration information from a Vesta-2 configuration file named vesta.cfg. It first looks for this file in the current directory; if none is found there, it looks in your home directory.

The configuration file is divided into a number of sections, denoted in the file by [SectionName]. The variables used by VCacheMonitor are in the section denoted by [CacheServer]. Here are the relevant variables and their meanings; the types of the variables are shown in parentheses:

Host (string)
The name of the host on which the function cache to be monitored is running.

Port (integer)
The port number on which to contact the function cache.

See Also

VCache(1)

Author

Allan Heydon (caheydon@yahoo.com) 

Created on Sat May 31 19:09:39 PDT 1997 by heydon
Last modified on Mon Jan  5 14:20:44 EST 2004 by ken@xorian.net
     modified on Sun Aug 22 15:06:21 PDT 1999 by heydon
This page was generated automatically by mtex software.