rs_helpcounter

Displays information about counters.

Syntax

rs_helpcounter [{sysmon | duration | observer | monitor
	| must_sample | no_reset | keep_old} 
	| module_name [, {short | long}] | keyword [, {short | long}]]

Parameters

sysmon – Specifies those counters most useful for assessing performance and for gathering replication system profile information.
duration – Specifies all counters that measure duration with time intervals measured in one-hundedths of a second.
observer – Specifies counters that record the number of times an event occurs. For example, the number of times a message is read from a queue.
monitor – Specifies counters that record a current value. For example, the size in bytes of the message most recently read from the queue.
must_sample – Specifies counters that must keep sampling even if sampling is not turned on.
no_reset – Specifies counters whose values are not reset when admin stats, reset is executed.
keep_old – Specifies counters that keep both current and previous values.
module_name – The name of a module: dsi, dsiexec, sqt, cm, dist, rsi, sqm, repagent, and so on.
short – Tells Replication Server to print the display names, module names, and counter descriptions of counters specified.
long – Tells Replication Server to print values for every column in the rs_statcounters table.
keyword – Search keyword. Search in the counter long names, the counter display names, and counter descriptions.

Examples

Example 1 – Lists all module names, and syntax for using rs_helpcounter.

1> rs_helpcounter
2> go

ModuleName 
------------------------------ 
CM                             
DIST                           
DSI                            
DSIEXEC                        
REPAGENT                       
RSH
RSI                         
RSIUSER
SERV
SQM                            
SQMR                          
SQT                            
STS                            
SYNC                           
SYNCELE                        
(12 rows affected)

How to Use rs_helpcounter
----------------------------------------------------------------
rs_helpcounter  -> Shows module names and help.
rs_helpcounter [ sysmon | duration | observe | monitor
               | must_sample | no_reset | keep_old ]
rs_helpcounter ModuleName    [, {short | long }]
rs_helpcounter keyword       [, { short | long }]
   where “keyword” is part of the counter name, display name or description
   (return status = 0)

Example 2 – Lists the display names, module names, and counter descriptions for the SQM Reader.

rs_helpcounter sqmr, short

Display Name       Module Name   Counter Description
--------------     ------------   ------------------------------------------
BlocksRead         SQMR          Number of 16K blocks read from a stable
                                 queue by an SQM Reader thread.
ClocksReadCached   SQMR          Number of 16K blocks from cache read by
                                 an SQM Reader thread.
CmdsRead           SQMR          Commands read from a stable queue by an
                                 SQM Reader thread.
SQMRReadTime       SQMR          The amount of time taken for SQMR to read
                                 a block.
SleepsStartQR      SQMR          srv_sleep() calls by an SQM Reader
                                 client due to waiting for SQM thread to
                                 start.
SleepsWriteQ       SQMR          srv_sleep() calls by an SQM read client
                                 due to waiting for the SQM thread to
                                 write.
XNLInterrupted     SQMR          Number of interruptions so far when 
                                 reading large messages with partial
                                 read. Such interruptions happen due to
                                 time out, unexpected wakeup, or nonblock
                                 read request, which is marked as
                                 READ_POSTED.
XMLPartials        SQMR          Partial large messages read so far.
XNLReads           SQMR          Large messages read successfully so
                                 far. This does not count partial
                                 messages, or timeout interruptions.
(return status = 0)

Usage

rs_helpcounter lets you search the rs_statcounters system table.
When used with no parameters, rs_helpcounter prints out a list of modules and syntax.
For information about counter status and other counter information stored in the RSSD, see the rs_statcounters system table.

Permissions

Any user may execute this command.