Status Reports

This section describes the VolanoChat server real time status application. A synopsis of the command is given in the COM.volano.Status section of the Command Reference appendix. The status application allows you to gather a variety of performance statistics to 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.

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 if undefined.
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.
admin.port=8001: specifies the port number at which the administrative subsystem of the VolanoChat server accepts administrative connections.
status.interval=60: specifies the interval in seconds at which to receive the status reports.

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 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.

Output formats

The format of the status application output can be configured by modifying its Java message format patterns.

format.date

defines the format of the date field.

format.status.memory

defines the format of information about the VolanoChat server's heap memory:

{0} the number of kilobytes in use,
{1} the number of kilobytes available, and
{2} the percentage of heap memory in use.

format.status

defines the overall format of the status report messages:

{0} the date and time this status record was taken, formatted by the format.date pattern above,
{1} the string formatted by the format.status.memory pattern above,
{2} the number of active Java threads,
{3} the number of active connections,
{4} the number of public chat rooms,
{5} the number of personal chat rooms,
{6} the number of private chat sessions,
{7} the average number of messages received per second during the interval,
{8} the average number of messages sent per second during the interval, and
{9} the average total number of messages sent and received per second during the interval.

The applet worksheet below lets you try out different status report formats right on this Web page.

Applet 4.4: Status report format worksheet.

To format the status reports for direct importing into a spreadsheet program as comma separated values, you might try the following message patterns:

format.date: M/d/y HH:mm:ss
format.status.memory: {0,number,0}, {1,number,0}, {2,number,0}
format.status: "{0}", {1}, {2,number,0}, {3,number,0}, {4,number,0}, {5,number,0}, {6,number,0}, {7,number,0}, {8,number,0}, {9,number,0}

which will give you status reports like the following:

"5/13/98 22:48:53", 5731, 8664, 66, 301, 146, 12, 0, 32, 5, 35, 40

Check HTML

Table of Contents