9.3 COM.volano.Status

COM.volano.Status captures real time status reports from the VolanoChat server. The status application allows you to gather a variety of performance statistics about your VolanoChat server including heap memory usage, Java thread counts, connection counts, the number of public, personal, and private chat rooms, and the average number of messages received and sent per second. This information is commonly used to put a real-time count of chatters onto a webpage. Before you use the Status module, you need to first set a password for admin.password in your properties.txt file. (For more information, see [5.2] Server Properties)

Synopsis

java -cp lib/volanochat-server.jar COM.volano.Status [ options ]

Description

COM.volano.Status makes a network connection to the VolanoChat server and requests it to generate status reports at a regular interval. It formats and prints each status report received. See the [5.6] Report Formatting section for a complete description on how to modify the report formats.

Options

-cp lib/volanochat-server.jar: This command tells Java to look inside the .jar file for the Shutdown module.
file: Specifies the path to the VolanoChat server properties file that defines the applications's configuration. If no file is specified, the application looks for its properties in a file conf/properties.txt, relative to the current working directory.

Application Properties

The following VolanoChat server properties must be defined for the status application. By default, these properties are located in the properties.txt file in the VolanoChat installation directory. Each property is shown with its default value below:

server.host=: specifies the name of the host running the VolanoChat server, with a default of localhost.
admin.port=8001: specifies the port number at which the administrative subsystem of the VolanoChat server accepts administrative connections.
admin.password=: defines the password required to make an administrative connection to the VolanoChat server. The default defines no administrator password, so you must define a value in order to run the status application.
status.interval=60: specifies the interval at which to receive the status reports.
format.date=[dd/MMM/yyyy:HH:mm:ss z]: gives the date format template to be used in formatting time stamps for the status reports.
format.status={0} {1} {2} {3,number,0} {4,number,0} {5,number,0} {6,number,0} {7,number,0} {8,number,0}: gives the message format template to be used in formatting the status report messages.
format.status.memory={0,number,0}KB/{1,number,0}KB {2,number,0%}: gives the message format template to be used in formatting the heap memory usage part of the status report.
format.status.resources={0,number,0} {1,number,0} ({2,number,0}): gives the message format template to be used in formatting the thread and connection count part of the status report.

In particular, you'll need to define an administrative password in order to connect to the VolanoChat server for status reports. Once these properties are defined, you can obtain real time status reports by entering the following command from the VolanoChat server installation directory:

java -cp lib/volanochat-server.jar COM.volano.Status

You may redirect the output to a file in order to save all of the performance statistics for later analysis by a spreadsheet program, for example.

Environment Variables

CLASSPATH: Used to provide the system a path to user-defined classes. Directories are separated by semicolons on Windows and colons on UNIX. The classpath needs to point to the lib/volanochat-server.jar archive of your VolanoChat installation.