Retrieve processing statistics for specified duration for commands.
Namespace: NetricsServerInterface
Assembly: NetricsServerInterface (in NetricsServerInterface.dll)
Syntax
| Visual Basic (Declaration) |
|---|
| Public Function cmdstats( _ ByVal cmd_names As String(), _ ByVal duration As Double _ ) As NetricsCmdStats() |
| C# |
|---|
| public NetricsCmdStats[] cmdstats( string[] cmd_names, double duration ) |
| C++ |
|---|
| public: array<NetricsCmdStats>^ cmdstats( array<String>^ cmd_names, double duration ) sealed |
| J# |
|---|
| public NetricsCmdStats[] cmdstats( string[] cmd_names, double duration ) |
| JScript |
|---|
| public
function cmdstats( cmd_names : String[], duration : double ) : NetricsCmdStats[] |
Parameters
- cmd_names
- The names of the commands to be included in the report. The class NetricsCmdStats has defines of all command names.
- duration
- The time period in seconds to be covered by this report.
Return Value
An array of NetricsCmdStats objects, one per requested command.
Remarks
This reports statistics for the named commands starting from the present moment going duration seconds into the past. A command name of NetricsCmdStats.CMD_ALL can be used to retrieve statistics for all commands.
The duration value is approximate. Each time a report request is made that does not request a specific end_time a reporting tic-mark is made at that time. The start and end time for a report will be reset to the closest time tic-mark set by a previous report. (This implies the first report always includes the entire time span since the start of the server.) The normal procedure is to equest reports at a fixed interval requesting durations in units of the request interval. E.g. request a report every 5 minutes covering a 15 minute period.