PMDF popstore & MessageStore Manager's Guide
PMDF-POP-6.0

The show_counters command is used to display channel counters for PMDF channels such as the popstore channel. The parameter names and associated values accepted by the command are listed in Table 4-19 .

Table 4-19 show_counterscommand parameters

parameter=value		Description
channel=name	Optional	Name of the channel for which to display information If omitted, then information on all channels is displayed. name may contain wild card characters.
mformat=file-spec	Optional	Name of the formatting file to use to format each set of channel counters. The recognized substitution strings for this formatting file are listed in Tables 4-10 and 4-20 . At least one of mformat or pformat must be specified.
on_error=file-spec	Required	Name of the formatting file to use to format the results when the command fails.
on_success=file-spec	Required	Name of the formatting file to use to format the results when the command succeeds.
pformat=file-spec	Optional	Name of the formatting file to use to format each set of channel counters. The recognized substitution strings for this formatting file are listed in Tables 4-10 and 4-20 . At least one of mformat or pformat must be specified.
rooted=bvalue	Optional	Boolean value, 0 or 1, indicating whether or not an exact channel name match is performed. When bvalue is 0, only the channel, if any, exactly matching the channel name string is returned. When bvalue is 1, then the channel name string is treated as a prefix and any channels with names beginning with the supplied name will be returned. When not specified, a bvalue of 0 is assumed.

At least one of mformat and pformat must appear in the command. Both may appear in which case the output generated by both formatting files will be included in the response.⁴

An example command to show channel counters for the popstore channel is shown below:

command=show_counters&channel=popstore&pformat=counters.txt& 
  on_success=counters_success.txt&on_error=counters_error.txt 

Example 4-3 show_countersformatting file

%none{No matching channels found} 
%first{Channel                                   Stored messages} 
%first{---------------------------------------------------------} 
%counter_channel{%-40s}  %counter_stored_messages 

Table 4-20 show_counterscommand substitution strings

Substitution string	Type	Format	Description
%counter_channel	string	%s	The channel's name.
%counter_delivered_messages	int	%d	Total cumulative count of messages processed (dequeued) by the channel.
%counter_delivered_recipients	int	%d	Total cumulative count of message recipients processed (dequeued) by the channel.
%counter_delivered_volume_b %counter_delivered_volume_k %counter_delivered_volume_m %counter_delivered_volume_g	float	%.2f	Total cumulative count of message volume processed (dequeued) by the channel as measured in bytes (_ b), kbytes ( _k), mbytes ( _m), and gbytes ( _g).
%counter_received_messages	int	%d	Total cumulative count of messages sent to the channel (messages enqueued to the channel).
%counter_received_recipients	int	%d	Total cumulative count of message recipients sent to the channel (recipients enqueued to the channel).
%counter_received_volume_b %counter_received_volume_k %counter_received_volume_m %counter_received_volume_g	float	%.2f	Total cumulative count of message volume sent to the channel (enqueued to the channel) as measured in bytes ( _b), kbytes ( _k), mbytes ( _m), and gbytes ( _g).
%counter_stored_message_files	uint	%u	Count of message files currently stored in the popstore.
%counter_stored_messages	int	%d	Count of messages currently enqueued (sent) to the channel.
%counter_stored_profile_files	uint	%u	Count of popstore user accounts (profile files).
%counter_stored_recipients	int	%d	Count of recipients currently enqueued to the channel.
%counter_submitted_messages	int	%d	Total cumulative count of messages sent by the channel (enqueued by the channel).
%counter_submitted_recipients	int	%d	Total cumulative count of message recipients sent to by the channel (enqueued to by the channel).
%counter_submitted_volume_b %counter_submitted_volume_k %counter_submitted_volume_m %counter_submitted_volume_g	float	%.2f	Total cumulative count of message volume sent by the channel (enqueued by the channel) as measured in bytes ( _b), kbytes ( _k), mbytes ( _m), and gbytes ( _g).

Note

⁴ The utility of specifying both mformat and pformat lies in having one format normal channel counter information and the other format popstore message and profile counts. That then allows a command to optionally display just channel counters or both channel counters and popstore message and profile counts. Note that counting the number of popstore messages can be slow which is why a manager may not wish to always view that information.