SNFClient Command Line: Get Realtime Status Information

SNFClient.exe -status.second
SNFClient.exe -status.minute
SNFClient-exe -status.hour

This mode reports the current status of the SNF engine on the local system.

If the command is successful then the result code will be zero and the requested status report (second, minute, or hour) will be displayed (stdout).

If the command is not successful then a non-zero result code (usually 99) will be returned and no status report will be displayed (stdout).

Usually SNFClient returns a zero (fail-safe) result code when an error occurs. THIS IS NOT TRUE of the -status.xxxx mode. This allows systems to use the -status.xxxx mode to check the health of the SNF Engine. If a nonzero result is returned then there is a problem with the SNF Engine.

Here is an example of using -status.second to check the health of the SNF Engine. In this case, the SNFServer has been shut down so there is no SNF Engine to respond to the request. SNFClient waits a few seconds while it tries to connect to the SNF Engine via it's XCI interface. When that fails it returns a non-zero value and does not produce a status report:

>SNFClient.exe -status.second

>echo %errorlevel%
99

Here is an example of using -status.minute to check the health of the SNF Engine and examine current message rates and other interesting data. The status report that is returned is in XML format:

>SNFClient.exe -status.minute

<!-- Status Report -->
<stats nodeid='xxxxxxxx' basetime='20080507203350' elapsed='60610' class='minute'>
  <version>
    <engine>SNFMulti Engine Version 2.9rc20 Build: Apr 10 2008 22:26:09</engine>
    <platform>SNF Server Version 2-9b2 Build: Apr 10 2008 17:40:38</platform>
  </version>
  <timers>
    <run started='20080411023442' elapsed='2311209'/>
    <sync latest='20080507203429' elapsed='22'/>
    <save latest='20080507203140' elapsed='191'/>
    <condense latest='20080507131332' elapsed='26479'/>
  </timers>
  <gbudb>
    <size bytes='142606336'/>
    <records count='678177'/>
    <utilization percent='98.5258'/>
  </gbudb>
  <counters>
    <m c='3668'/>
    <s c='3653'/>
    <h c='15'/>
    <t c='862'/>
    <b c='1'/>
  </counters>
  <rates>
    <m s='62.1796' m='3640.13' h='219589' d='4.21389e+006'/>
    <s s='61.6835' m='3623.93' h='218738' d='4.17159e+006'/>
    <h s='0.496114' m='16.2023' h='851.386' d='42302.5'/>
    <w s='0' m='0' h='0' d='0'/>
    <c s='0' m='0' h='1.77003' d='2295.28'/>
    <b s='0' m='0.900131' h='27.4355' d='2184.11'/>
    <t s='16.5371' m='865.926' h='47632.5' d='995030'/>
    <a s='0' m='0' h='0' d='0'/>
    <r s='0' m='0' h='0' d='0'/>
  </rates>
  <results>
    <histogram hits='3668'>
      <g k='0' c='15'/>
      <g k='5' c='73'/>
      <g k='20' c='862'/>
      <g k='47' c='1'/>
      <g k='50' c='16'/>
      <g k='52' c='2196'/>
      <g k='53' c='8'/>
      <g k='54' c='107'/>
      <g k='57' c='6'/>
      <g k='58' c='8'/>
      <g k='59' c='1'/>
      <g k='60' c='374'/>
      <g k='63' c='1'/>
    </histogram>
  </results>
  <rules>
    <rulebase utc='20080507202625'/>
    <active utc='20080507202625'/>
    <update ready='no' utc='20080507202429'/>
    <latest rule='1879554'/>
    <histogram hits='2790'>
      <g k='18291' c='611'/>
      <g k='32625' c='2'/>

      ... many additional entries omitted ...
	
      <g k='1879153' c='2'/>
      <g k='1879158' c='4'/>
      <g k='1879172' c='2'/>
      <g k='1879370' c='2'/>
    </histogram>
  </rules>
  <panics>
  </panics>
</stats> 

For detailed information about the data contained in a status report please read the section on Status Logs.

Related Topics