NetricsServerInterface.NetricsCmdStats Class Reference

This class contains summary statistics from the server on usage of a particular command. More...

Public Member Functions
override string	ToString ()
	Return report as a string.
String	cmd_name ()
	Return the command name.
double	start_time ()
	Return the start time of this report.
double	end_time ()
	Return the end time of this report.
double	duration ()
	Return the number of milliseconds covered by this report.
int	num_cmds ()
	The number of these commands completed during the report time period.
double	min_proc ()
	The minimum processing time for this command during the report time period.
double	max_proc ()
	The maximum processing time for this command during the report time period.
double	tot_proc ()
	The total processing time for all of these commands completed during the report time period.
double	avg_proc ()
	The average processing time for these commands completed during the report time period.
double	min_overhead ()
	The minimum overhead time for this command during the report time period.
double	max_overhead ()
	The maximum overhead time for this command during the report time period.
double	tot_overhead ()
	The total overhead time for all of these commands completed during the report time period.
double	avg_overhead ()
	The average overhead time for these commands completed during the report time period.
double	min_full ()
	The minimum full time for this command during the report time period.
double	max_full ()
	The maximum full time for this command during the report time period.
double	tot_full ()
	The total full time for all of these commands completed during the report time period.
double	avg_full ()
	The average full time for these commands completed during the report time period.
double	max_thru ()
	The maximum throughput over a one minute interval for these commands completed during the report time period.

Static Public Attributes
static readonly String	CMD_ALL = "ALL"
	Special "command" that means all commands.
static readonly String	CMD_TBL_LOAD = "dbload"
	The table load command.
static readonly String	CMD_TBL_DELETE = "dbdelete"
	The table delete command.
static readonly String	CMD_TBL_MOVE = "dbmove"
	The table move (rename) command.
static readonly String	CMD_TBL_CHECKPOINT = "checkpoint"
	The table checkpoint command.
static readonly String	CMD_TBL_RESTORE = "restore"
	The table restore command.
static readonly String	CMD_CHPT_STATS = "chptstats"
	Return information on last checkpoint (internal cmd only).
static readonly String	CMD_TBL_LIST = "dblist"
	The table list (table statistics) command.
static readonly String	CMD_IDX_LIST = "idxlist"
	The index list command (for partitioned indexes).
static readonly String	CMD_REC_GET = "dbrecget"
	The record get command.
static readonly String	CMD_REC_ADD = "dbrecadd"
	The record add command.
static readonly String	CMD_REC_DELETE = "dbrecdelete"
	The record delete command.
static readonly String	CMD_REC_REPLACE = "dbrecreplace"
	The record replace command.
static readonly String	CMD_REC_UPDATE = "dbrecupdate"
	The record update command.
static readonly String	CMD_REC_RECNEXT = "dbrecnext"
	Retrieve the next record from the table.
static readonly String	CMD_THESAURUS_CREATE = "thcreate"
	The thesaurus create command (includes weighted dict and combined).
static readonly String	CMD_THESAURUS_DELETE = "thdelete"
	The thesaurus delete command (includes weighted dict and combined).
static readonly String	CMD_THESAURUS_LIST = "thlist"
	The thesaurus list command (includes weighted dict and combined).
static readonly String	CMD_CHARMAP_CREATE = "cmapcreate"
	The Character Map Create command.
static readonly String	CMD_CHARMAP_LIST = "cmaplist"
	The Character Map List command.
static readonly String	CMD_MODEL_CREATE = "rlcreate"
	The Learning Model create/load command.
static readonly String	CMD_MODEL_DELETE = "rldelete"
	The Learning Model delete command.
static readonly String	CMD_MODEL_LIST = "rllist"
	The Learning Model list command.
static readonly String	CMD_MODEL_EVALUATE = "rleval"
	The Learning Model evaluate command.
static readonly String	CMD_SEARCH = "dbsearch"
	The search (query) command.
static readonly String	CMD_SCORE_RECORDS = "scorerecs"
	Compute match score for a set of records.
static readonly String	CMD_SVR_SHUTDOWN = "svrshutdownex"
	The server shutdown command.
static readonly String	CMD_SVR_NOOP = "svrnoop"
	The server No-Op (do nothing) command.
static readonly String	CMD_SVR_LOGON = "svrlogon"
	The server turn Query logging on command.
static readonly String	CMD_SVR_LOGOFF = "svrlogoff"
	The server turn Query logging off command.
static readonly String	CMD_SVR_VERSION = "svrversion"
	The fetch server version info command.
static readonly String	CMD_SVR_CMDSTATS = "cmdstats"
	The fetch command statistics command.
static readonly String	CMD_TRAN_CREATE = "trancreate"
	Start an explicit transaction.
static readonly String	CMD_TRAN_COMMIT = "trancommit"
	Commit an explicit transaction.
static readonly String	CMD_TRAN_ABORT = "tranabort"
	Abort an explicit transaction.
static readonly String	CMD_TRAN_LIST = "tranlist"
	List open transactions.
static readonly String	CMD_TRAN_MONITOR = "tranmon"
	Monitor transactions.
static readonly String	CMD_GATEWAY_CONFIG = "clcfgreload"
	Reload gateway configuration.

Detailed Description

This class contains summary statistics from the server on usage of a particular command.

A summary report on the number of commands processed, minimum, maximum, total and average processing time can be obtained from ibi™ Patterns - Search. This class contains the report for one command.

Note that "command" as used here are commands from the server's point of view. This may not correspond to calls from the .NET API. Normally a number of different API calls will map to the same server command. A static list of server command names is provided with this class.

Time values are reported in milliseconds since an arbitrary epic point. They can't be correlated with with real time clock values. Negative values mean a time was not reported.

Durations are reported in milliseconds. Negative values means a duration was not reported.

Three types of timing values are reported:

Full time is the time from when the command request was first received by the server until writing of the response was completed.

Processing time is the time taken to actually perform the actions associated with the command.

Overhead time is the difference between Full and Processing time. It includes any time spent waiting for a worker thread to become available and the time spent reading and writing the response. (An exception to this is the commands that read records, where the time spent reading the records is included in Processing time.)

Objects of this class are generated as the results of a NetricsServerInterface.cmdstats call, they can't be created directly.

See also

NetricsServerInterface.cmdstats(String[],double,double)

Member Function Documentation

cmd_name()

String NetricsServerInterface.NetricsCmdStats.cmd_name ( )

inline

Return the command name.

Returns the command name, the special value "<unknown>" if no command name was received.

duration()

double NetricsServerInterface.NetricsCmdStats.duration ( )

inline

Return the number of milliseconds covered by this report.

The total time span covered by this report in milliseconds. A value of -1.0 indicates the duration could not be calculated.

end_time()

double NetricsServerInterface.NetricsCmdStats.end_time ( )

inline

Return the end time of this report.

Returns a value indicating the most recent time covered by this report. Time is measured in milliseconds from an arbitrary epic point. A value of -1.0 indicates no end time was given.

start_time()

double NetricsServerInterface.NetricsCmdStats.start_time ( )

inline

Return the start time of this report.

Returns a value indicating the earliest time covered by this report. Time is measured in milliseconds from an arbitrary epic point. A value of -1.0 indicates no start time was given.

ToString()

override string NetricsServerInterface.NetricsCmdStats.ToString ( )

inline

Return report as a string.

This formats the report into a multi line human readable report.

Returns

human readable report as a string.