Viewing Guaranteed Messaging Information

You can use several show commands to view Guaranteed Messaging configurations and status on Solace PubSub+ event brokers.

Queue Information

To view the message queue configuration and status on the event broker for the message spooling mechanism used to support the persistent store notion of JMS queues and topics, enter the following User EXEC command.

solace> show queue <name> [message-vpn <vpn-name>] [stats | messages [oldest | newest] [msg-id <msg-id>] | subscriptions | rates | sort-by-messages-spooled | sort-by-unacked-messages-spooled] | dead-message-queue <dmq-filter> [dmq-list]] [durable | non-durable] [detail] [flow <flow-id>] [count <num-elements>]

Where:

<name> is the full name of the message queue, or part of the queue name with the wildcard character ? used to represent one character of the name, or the wildcard character * used to represent zero or more characters of the name, where entering only the wildcard character * for the name displays all message queues.

<vpn-name> is the name of the Message VPN the queue belongs to.

stats specifies to show statistics associated with the message queue spool.

messages specifies to show information on the spooled messages associated with the message queue.

oldest specifies to show spooled messages in order from oldest to newest.

newest specifies to show spooled messages in order from newest to oldest.

msg-id specifies to show the spooled messages starting from the message identifier number specified by <msg-id>.

subscriptions specifies to show the topic subscriptions added to the associated message queue.

rates specifies to show ingress and egress message rates associated with the queue.

durable specifies to show information on the active durable message queues.

non-durable specifies to show information on the active non-durable message queues.

detail specifies to show detailed information on the spooled messages.

flow <flow-id> specifies to show the message flow identifier associated with a given ingress or egress message flow. <flow-id> is the integer identifying the ingress or egress message flow to be displayed. Valid values are 0 through 16383.

sort-by-messages-spooled specifies to sort the display output in descending order for number of messages spooled for the given queue.

sort-by-unacked-messages-spooled specifies to sort the display output in descending order for number of unacked messages spooled for the given queue.

dead-message-queue <dmq-filter> specifies to show only those queues that use the given <dmq-filter> as their dead-message queue

dmq-list specifies to list the queues associated with the dead message queue. Note that if the detail option is used, the dmq-list is ignored.

durable specifies to show durable queues only

non-durable specifies to shownon-durable queues only

detail specifies to show detailed information

flow <flow-id> specifies to show queue details for the given Guaranteed Message FlowID. Valid values are 1 through 4294967295.

count <num-elements> specifies the number of display elements to show. Valid values are 1 through 4294967295.

A detailed configuration and status summary screen example for message queue:

solace> show queue test_td message-vpn default detail

 

Name                                 : test_td

Message VPN                          : default

Durability                           : Durable

Id                                   : 2100

Type                                 : Primary

Admin Ingress                        : Down

Admin Egress                         : Down

Access Type                          : Exclusive

Owner                                :

Created by mgmt                      : Yes

All Others Permission                : No-Access (0000)

Quota (MB)                           : 4000

Respect TTL                          : No

Reject Msg to Sender on Discard      : Yes

Bind Time Forwarding Mode            : Store-And-Forward

Current Messages Spooled             : 0

Current Spool Usage (MB)             : 0.0000

High Water Mark (MB)                 : 0.0000

Total Delivered Unacked Msgs         : 0

Max Delivered Unacked Msgs Per Flow  : 250000

Total Acknowledgments In-Progress    : 0

Max Redelivery                       : 3

Consumer Ack Propagation             : Yes

Reject Low-Priority-Msg              : No

Reject Low-Priority-Msg Limit        : 0

Low-Priority-Msg Congestion State    : Disabled

Oldest Msg Id in Spool               : N/A

Newest Msg Id in Spool               : N/A

Max Msg Size Allowed (B)             : 10000000

Bind Count                           : 0

Max Bind Count                       : 1000

Topic Subscription Count             : 0

Network Topic                        : #P2P/QUE/test_td

Egress Selector Present              : No

 

Event Threshold                           Set Value      Clear Value

---------------------------------- ---------------- ----------------

Bind count                                 80%(800)         60%(600)

Spool usage (MB)                          80%(3200)        60%(2400)

Reject Low-Priority-Msg Limit                80%(0)           60%(0)

 

Egress Flows

 

  Client Name                        : solace2/6542/#00010001

    Flow Status                      : Active-Consumer

    Deliver From                     : RAM

    Status Updates                   : Not Requested

    No Local Delivery                : No

    Request Redelivery               : No

    Selector                         :

    Window Size                      : 255

    Last Connect Time                : 2011-10-19 14:21:52 UTC

    Activation Time                  : 2011-10-19 14:21:52 UTC

    Flow Id                          : 13

    Last Msg Id Delivered            : 0

  • The status item ‘Deliver From’ under the Egress Flows section displays the Guaranteed message egress flow source as being delivered from either ‘input stream,’ ‘RAM,’ or ‘ADB or disk’.
  • When Guaranteed messages are being delivered immediately after being spooled, the egress flow is in the delivered from ‘input stream’ state. When Guaranteed messages are being delivered once the client is ready, thus requiring further processing, the egress flow is in either the delivered from ‘RAM’ or ‘ADB or disk’.
  • Guaranteed messages delivered from RAM require further processing, but are not necessarily copied to/from the ADB or disk (for example, queues with selectors, or queues with transient closures on their transport window).
  • Guaranteed messages delivered from input stream have lower latency than messages requiring further processing, while Guaranteed messages delivered from RAM have lower latency than messages delivered from ADB or disk.

A statistics summary screen example for message queue:

solace> show queue dave2 stats

 

Name: dave2

 

Message VPN: solace

 

Message Spool Statistics (since reload/clear)

 

  Last Message Id Spooled:                       34659

  Low Message Id Ack Rcv:                        34659

  High Message Id Ack Rcv:                       34659

  Message Redelivered:                               0

  Bytes Spooled:                                  1030

  Messages Spooled:                                  4

 

Ingress Spool Discard Statistics

 

  Spool Usage Exceeded:                               0

  Max. Message Size Exceeded:                         0

  Spool Shutdown Discard:                            11

  User Profile Deny Guaranteed:                       0

  No Local Delivery Discard:                          0

  Destination Group Error:                            0

  Low-Priority-Msg Congestion Discard:                0

 

Egress Spool Discard Statistics

 

  Messages Deleted:                                   0

  Messages Expired To Discard:                        0

  Messages Expired To #DEAD_MSG_QUEUE:                0

  Messages Expired To #DEAD_MSG_QUEUE Failed:         0

  Max Redelivery Exceeded To Discard:                10

  Max Redelivery Exceeded To #DEAD_MSG_QUEUE:         5

  Max Redelivery Exceeded To #DEAD_MSG_QUEUE Failed:  0

  TTL Exceeded To Discard:                            0

 

Replication Statistics

 

  Active Statistics

  Ack Propagation Messages Sent:                      0

 

  Standby Statistics

    Messages Received From Active:                    0

    Messages Acked Via Ack Propagation:               0

    Ack Propagation Messages Received:                0

 

 

Egress Flow Statistics

 

  Flow Id (State):                              13 (Deliver from RAM)

 

    Transport Statistics

      Window Size:                               255

      Used Window:                               0

        Low Message Id AckPending:               0

        High Message Id AckPending:              0

      Window Closed:                             0

      Message Redelivered:                       0

    Application Statistics

      Message Confirmed Delivered:               0

        Store and Forward:                       0

        Cut Through:                             0

      Unacked Messages:                          0

      Max Delivered Unacked Msgs Exceeded:       0

 

 

Client Bind Statistics

 

  Client Bind Requests:                          5

  Client Bind Responses:                         4

    OK:                                          3

    Already Bound:                               0

    Exceeded Clients:                            0

    Queue/TE Shutdown:                           1

    Invalid Selector:                            0

    Other:                                       0

  • The item ‘Flow Id (State)’ under the Egress Flow Statistics section displays the Guaranteed message egress flow source as ‘Deliver from input stream,’ ‘Deliver from RAM,’ or ‘Deliver from ADB or disk’.
  • When Guaranteed messages are being delivered immediately after being spooled, the egress flow is in the ‘Delivered from input stream' state. When Guaranteed messages are being delivered once the client is ready, thus requiring further processing, the egress flow is in either the ‘Deliver from RAM’ or ‘Deliver from ADB or disk’ state.
  • Guaranteed messages delivered from RAM require further processing, but are not necessarily copied to/from the ADB or disk (for example, queues with selectors, or queues with transient closures on their transport window).
  • Guaranteed messages delivered from input stream have lower latency than messages requiring further processing, while Guaranteed messages delivered from RAM have lower latency than messages delivered from ADB or disk.

Clearing Queue Statistics

To clear the statistics for message queues on event brokers, enter the following Privileged EXEC command:

solace> enable
solace# clear queue <name> message-vpn <vpn-name> stats

Where:

<name> is the message queue name

<vpn-name> is the name of the Message VPN that the queue belongs to

Topic Endpoint Information

To view the topic endpoint configuration and status on the event broker for the message spooling mechanism used to support the persistent store notion of JMS queues and topics, enter the following User EXEC command.

solace> show topic-endpoint <name> [message-vpn <vpn-name>] [stats | messages [oldest | newest] [msg-id <msg-id>] | topics | rates | sort-by-messages-spooled] [durable | non-durable] [detail] [flow <flow-id>] [count <num-elements>]

Where:

<name> is the full name of the durable topic endpoint, or part of the durable topic endpoint name with the wildcard character ? used to represent one character of the name, or the wildcard character * used to represent zero or more characters of the name, where entering only the wildcard character * for the name displays durable topic endpoints.

<vpn-name> is the name of the Message VPN the topic endpoint belongs to.

stats specifies to show statistics associated with the durable topic endpoint.

messages specifies to show the spooled messages associated with the durable topic endpoint.

oldest specifies to show spooled messages in order from oldest to newest.

newest specifies to show spooled messages in order from newest to oldest.

msg-id <msg-id> specifies to show the spooled messages starting from the message identifier specified by <msg-id>.

topics specifies to show the topics associated with the durable topic endpoint.

rates specifies to show ingress and egress message rates associated with the topic endpoint.

durable specifies to show information on the active durable message queues.

non-durable specifies to show information on the active non-durable message queues.

detail specifies to show detailed information on the durable topic endpoint.

flow <flow-id> specifies to show the message flow identifier associated with a given ingress or egress message flow. <flow-id> is the integer identifying the ingress or egress message flow to be displayed. Valid values are 0 through 16383.

sort-by-messages-spooled specifies to sort the display output in descending order for number of messages spooled for the given topic-endpoint.

sort-by-unacked-messages-spooled specifies to sort the display output in descending order for number of unacked messages spooled for the given topic endpoint.

count <num-elements> specifies the number of display elements to show. <num-elements> is the integer specifying the number of elements. Valid values are 1 through 4294967295.

Clearing Topic Endpoint Statistics

To clear the statistics for topic endpoints on event brokers, enter the following Privileged EXEC command:

solace> enable
solace# clear topic-endpoint <name> message-vpn <vpn-name> stats

Where:

<name> is the name of the durable topic endpoint

<vpn-name> is the name of the Message VPN the durable topic endpoint belongs to

Message Spool Information

To view Guaranteed Messaging message status and usage, enter the following User EXEC command.

solace> show message-spool [message-vpn <vpn-name>] stats | detail | rates]

Where:

message-vpn <vpn-name> is the name of a Message VPN to show message spool information

stats specifies to show statistics on all spooled messages

detail specifies to show detailed information on the message spool facility

rates specifies to show information on ingress and egress subscription rates for active queues and topic endpoints

Example of standard status and usage summary screen for spooled messages:

solace> show message-spool

 

Config Status:                         Enabled (Primary)

Maximum Spool Usage:                   800000 MB

Spool While Charging:                  No

Spool Without Flash Card:              No

Using Internal Disk:                   No

Disk Array WWN:                   60:06:01:60:40:40:12:00:64:4a:49:9f:9d:6a:dc:11

 

Operational Status:                       AD-Active

Datapath Status:                          Up

Synchronization Status:                   Synced

Max Message Count:                        10000M

Message Count Utilization:                67.17%

Transacted Session Resource Utilization:  0.00%

Delivered Unacked Msgs Utilization:       0.00%

Spool Files Utilization:                  0.00%

Active Disk Partition Usage:              0.00%

Standby Disk Partition Usage:             81.36%

Next Message Id:                          14502

Number of delete in-progress:             0

 

                                              ADB         Disk          Total

Current Persistent Store Usage (MB)        0.1076    4003.2071      4003.3147

Number of Messages Currently Spooled           11       409475         409486

  • the number of messages spooled—Always be aware of how this limit can be hit with fanout. For example, if one message is destined for spooling on 50 offline clients, there is then 50 spooled messages to track. To determine how much of the message spool capacity you are actually using, check the “Message Count Utilization (%)” field of the show message-spoolUser EXEC command output.
  • the amount of local disk storage—The maximum amount of message spool disk space that can be used by the event broker (the Maximum Spool Usage) is a general measurement because there is also overhead stored for each message. To determine how much of the local disk storage capacity you are actually using, check the “Current Persistent Storage Usage (MB)” field under the “Disk” heading of the show message-spoolUser EXEC command output.

Example of detailed status and usage summary screen for message spool facility:

solace> show message-spool detail

 

Config Status:                            Enabled (Primary)

Maximum Spool Usage:                      60000 MB

Spool While Charging:                     No

Spool Without Flash Card:                 No

Using Internal Disk:                      Yes

Disk Array WWN:                           N/A

 

Operational Status:                       AD-Active

Datapath Status:                          Up

Synchronization Status:                   Synced

Max Message Count:                        10000M

Message Count Utilization:                0.00%

Transacted Session Resource Utilization:  0.00%

Delivered Unacked Msgs Utilization:       0.00%

Spool Files Utilization:                  0.00%

Active Disk Partition Usage:              79.81%

Standby Disk Partition Usage:             1.63%

Next Message Id:                          14502

Defragmentation Status:                   Idle

Number of delete in-progress:             0

 

                                       Currently Used   Max Allowed

                                       --------------   -----------

Queue and Topic-endpoint Spools:                    0         16000

                         Queues:                    0

                Topic-endpoints:                    0

            Transacted Sessions:                    0         16000

                          Local:                    0

                             XA:                    0

                   Transactions:                    8         50000

                          Local:                    0

                             XA:                    0

               Sequenced Topics:                    0          3000

      Queue Topic Subscriptions:                    0        100000

 

            Total Ingress Flows:                    0         16000

             Total Egress Flows:                    0         16000

            Active Egress Flows:                    0

          Inactive Egress Flows:                    0

           Browser Egress Flows:                    0

 

CVRID/LAG Config Status:       Ready

ADB Status:                    Ready

  Flash Module Status:           Ready

  Power Module Status:           Ready

ADB Contents:                    Ready

  Local Contents Key:            192.168.164.151:141,129

  Mate Contents Key:             192.168.164.151:141,129

  Schema Match:                  No

Disk Status:                   Ready

Disk Contents:                 Unknown

  Disk Key (Primary):            192.168.164.151:139,127

  Disk Key (Backup):             192.168.164.151:139,129

Last Failure Reason: Local ADB Key Invalid

Last Failure Time: Dec 10 2014 21:50:10 EST

 

                                              ADB         Disk           Total

Current Persistent Store Usage (MB)       165.1754  65642.8237      65807.9991

Number of Messages Currently Spooled        158786    72621057        72779843

 

 

Disk Partition       1K-blocks      Used Available Use% Mounted on

Active               113281832  52094848  55432508  49%    /usr/sw

 

 

Spool Files           Maximum       Used Available Use% Pending delete

  Active                          179039             4%              0

  Standby                            423             0%             32

  Total                3999999    179462    3820537 4%             32

 

Transaction:

  Replication Compatibility Mode: Transacted

 

Guaranteed Message Cache:      Enabled

Max Cache Usage:               10%

Current Cache Usage:           0.0%

High Water Mark:               0.0%

 

Event Threshold                           Set Value      Clear Value

---------------------------------- ---------------- ----------------

Endpoints                                80%(12800)        60%(9600)

Egress Flows                             80%(12800)        60%(9600)

Ingress Flows                            80%(12800)        60%(9600)

SpoolUsage (MB)                         80%(640000)      60%(480000)

Transacted Sessions                      80%(12800)        60%(9600)

Transactions                             80%(40000)       60%(30000)

Cache Usage (% NAB Resources)              80%(8.0)         60%(6.0)

Transacted Session Resources                    80%              60%

Spool Files                                     80%              60%

Message Count                                   80%              60%

Delivered Unacked                               80%              60%

Disk Usage                                      80%              60%

 

The following table describes the detailed status and usage items for spooled messages displayed in the bottom portion of the summary screen.

Detailed Status and Usage Items for Spooled Messages

Item

Description

Values

Currently used and maximum message-spool entities section

Summarizes message spool entities being used to spool messages for clients, queues, and durable topic endpoints.

  • Integer

Total Flows section

Summarizes publisher (ingress) and subscriber (egress) Guaranteed message flows being used.

  • Integer

CVRID/LAG Config Status

Indicates whether the local CVRID/LAG configuration has been completed.

  • Unknown
  • Ready

ADB Status

Summarizes the high-level status of the flash memory card module and power module on the ADB, as well as the ADB itself.

Note:  The ADB status is by default ‘Not Ready’ if either one of its modules is ‘Not Ready”.

  • Not Ready
  • Ready

ADB Contents

Indicates whether the contents of the ADB are valid.

  • Invalid
  • Stale
  • Ready

Contents Key(s)

This is an internal signature used on the ADB to ensure synchronization sanity and prevent issues due to mis-configuration.

Note:  Only the ‘Local Contents Key’ is shown for non-redundant systems.

On Solace PubSub+ appliances:

  • IP address followed by two integers

On Solace PubSub+ software event brokers:

  • 32-bit number in dotted quad notation followed by two integers

Disk Status

Indicates the status of either the internal disk, or external disk storage array (as applicable).

  • Not Ready
  • Ready

Disk Contents

Indicates whether the spool-file directory on the disk is valid. Will generally be “Unknown” on a Solace PubSub+ event broker that is not active.

  • Unknown
  • Mount Error

    (This state is set if the WWN can not be mounted)

  • Invalid

    (This state is set if there is an ownership conflict with the disk contents.)

  • Ready

Disk Key(s)

This is an internal signature used on the ADB to ensure synchronization sanity and prevent issues due to mis-configuration.

Note:  Only the ‘Disk Key (Primary)’ key is shown for non-redundant systems.

On Solace PubSub+ appliances:

  • IP address followed by two integers

On Solace PubSub+ software event brokers:

  • 32-bit number in dotted quad notation followed by two integers

Detailed statistics summary screen for spooled messages:

solace> show message-spool stats

 

************** Ingress Spool Discard Statistics ***************************

Spooling Not Ready:                                            0

Out Of Order Messages:                                         0

Duplicate Messages:                                            0

No Eligible Destinations:                                      0

Spool Over Quota:                                              0

Queue/Topic-Endpoint Over Quota:                               0

Max. Message Usage Exceeded:                                   0

Max. Message Size Exceeded:                                    0

Remote Router Spooling Not Supported:                          0

Spool To ADB Fail:                                             0

Spool To Disk Fail:                                            0

Spool File Limit Exceeded:                                     0

Errored Message:                                               0

Queue Not Found:                                               0

Spool Shutdown Discard:                                        0

User Profile Deny Guaranteed:                                  0

Publisher Not Found:                                           0

No Local Delivery Discard:                                     0

TTL Exceeded:                                                  0

Publish ACL Denied:                                            0

Destination Group Error:                                       0

Not Compatible With Forwarding Mode:                           0

Low-Priority-Msg Congestion Discard:                           0

Replication Is Standby Discard:                                0

Sync Replication Ineligible Discard:                           0

Other:                                                         0

 

*************** Egress Spool Discard Statistics ***************************

Messages Deleted:                                              0

Messages Expired To Discard:                                   0

Messages Expired To DMQ:                                       0

Messages Expired To DMQ Failed:                                0

Max Redelivery Exceeded To Discard:                            0

Max Redelivery Exceeded To DMQ:                                0

Max Redelivery Exceeded To DMQ Failed:                         0

TTL Exceeded To Discard:                                    1000

 

********************* Message Processing Statistics **********************

Number of Ingress Messages:                                    0

  Promoted to Non-Persistent:                                  0

  Demoted to Direct:                                           0

  Replicate Promoted:                                          0

  Async Replicated:                                            0

  Sync Replicated:                                             0

  From Replication Mate:                                       0

Sequenced Topic Matches:                                       0

Sequence Number Already Assigned:                              0

Sequence Number Rollover:                                      0

Sequence Numbered Messages Discarded:                          0

Transacted Messages Not Sequenced:                             0

Ingress Messages Discarded:                                    0

Messages Spooled to ADB:                                       0

Messages Spooled to Disk:                                      0

Messages Retrieved from ADB:                                   0

Messages Retrieved from Disk:                                  0

Guaranteed Message Cache Miss:                                 0

Messages Ingress Selector Examined:                            0

  Messages Selector Matched:                                   0

  Messages Selector Did Not Match:                             0

Messages Egress Selector Examined:                             0

  Messages Selector Matched:                                   0

  Messages Selector Did Not Match:                             0

Egress Messages Discarded:                                     0

Number of Egress Messages:                                     0

  Redelivered:                                                 0

Messages Confirmed Delivered:                                  0

  Store and Forward:                                           0

  Cut Through:                                                 0

  From Replication Mate:                                       0

Request for Redelivery:                                        0

 

*************** Transacted Session Processing Statistics ******************

Open Session:                                                  0

  Success:                                                     0

  Max Sessions Exceeded:                                       0

  Max Session Resources Exceeded:                              0

  Other:                                                       0

Transactions:                                                  0

  Success:                                                     0

    Commit:                                                    0

    Rollback:                                                  0

  Fail:                                                        0

  Msgs Published:                                              0

  Msgs Consumed:                                               0

  Max Transactions Exceeded:                                   0

  Max Transaction Resources Exceeded:                          0

 

*************** XA Transaction Processing Statistics **********************

Open Session:                                                  0

Success:                                                       0

  Max Sessions Exceeded:                                       0

  Other:                                                       0

Transaction Requests:                                       8552

  Success:                                                  8552

    Recover:                                                   0

    Start:                                                  2138

    Suspend:                                                   0

    Resume:                                                    0

    End:                                                    2138

    End Fail:                                                  0

    End Rollback:                                              0

    Prepare:                                                2138

    Commit:                                                 2084

    Rollback:                                                 54

    Forget:                                                    0

  Fail:                                                        0

    Recover:                                                   0

    Start:                                                     0

    Suspend:                                                   0

    Resume:                                                    0

    End:                                                       0

    End Fail:                                                  0

End Rollback:                                                  0

    Prepare:                                                   0

    Commit:                                                    0

    Rollback:                                                  0

    Forget:                                                    0

  Msgs Spooled to ADB:                                    134437

  Msgs Retrieved from ADB or Disk:                          7315

  Msgs Published:                                         127755

  Msgs Consumed:                                          127735

  Max Transactions Exceeded:                                   0

  Max Transaction Resources Exceeded:                          0

The following table describes the information logged in the detailed spooled message statistics.

Description of Detailed Spooled Message Statistics

Statistic

Description

Ingress Spool Discard Statistics:

Spooling Not Ready

Number of messages that could not be spooled and were discarded because the message spooling facility is not ready (for example, because the message spooling facility is not enabled or configured correctly through the CLI, or the ADB has detected a hardware fault).

Out of Order Messages

Number of messages that could not be spooled and were discarded because they were received out of order.

Duplicate Messages

Number of messages that could not be spooled and were discarded because they were duplicates.

No Eligible Destinations

Number of Guaranteed messages discarded because there is no existing endpoint that has a topic subscription matching the topic to which the message is published.

Spool Over Quota

Number of messages that could not be spooled and were discarded because the maximum allowed local message spool usage quota is exceeded.

Queue/Topic-Endpoint Over Quota

Number of messages that could not be spooled and were discarded because the maximum allowed message spool usage quota is exceeded.

Max. Message Usage Exceeded

Number of messages that could not be spooled and were discarded because the maximum allowed message usage count is exceeded.

Max. Message Size Exceeded

Number of messages that could not be spooled and were discarded because the maximum allowed message size is exceeded.

Remote Router Spooling Not
 Supported

Number of messages that could not be spooled and were discarded by remote event brokers because they do not have Guaranteed Messaging and message spooling activated through the message-spool Global CONFIG command.

Spool to ADB Fail

Number of messages that could not be spooled and were discarded because of a failure spooling to the ADB. For example, the Guaranteed messages could not be written to the ADB due to a hardware issue.

Spool to Disk Fail

Number of messages that could not be spooled and were discarded because spooling to the disk store failed (for example, due to being full)

Spool File Limit Exceeded

Number of messages that could not be spooled and were discarded because all spool file resources were used.

Errored Message

Number of messages that could not be spooled and were discarded due to detected errors.

Queue Not Found

Number of messages that could not be spooled and were discarded because the associated message queue could not be found (for example, because the message queue facility is not enabled or configured correctly through the CLI).

Spool Shutdown Discard

Number of messages that could not be spooled because ingress clients are disabled from publishing to the queue by the shutdownQueue CONFIG command.

User Profile Deny Guaranteed

Number of messages that could not be spooled because the user profile does not allow the publishing of Guaranteed messages.

Publisher Not Found

Number of messages that could not be spooled because the associated publisher could not be found.

No Local Delivery Discard

Number of messages discarded because they were sent to a queue or topic endpoint to which the same client as the message publisher is bound with No Local instruction.

TTL Exceeded

Number of messages discarded because the specified maximum Time to Live (TTL) value for a Message VPN bridge (as configured through the max-ttl Bridge CONFIG command) has been exceeded.

Publish ACL Denied

Number of messages discarded because the publish Access Control List (ACL) criteria has not been satisfied.

Destination Group Error

Number of Guaranteed messages discarded due to “reject-msg-to-sender-on-discard” being triggered on a different queue/topic endpoint in the same destination group. The destination group is the set of durable and/or temporary endpoints in the same Message VPN that have “reject-msg-to-sender-on-discard” turned on, as well as a topic subscription matching the topic to which the message is published.

Not Compatible With Forwarding
Mode

Number of Guaranteed messages that cannot be written to an endpoint because they are incompatible with the forwarding mode of the endpoint. Most likely cause is the endpoint is in Cut-Through Messaging delivery mode and the message does not have a publisher id.

Low-Priority-Msg Congestion Discard

Number of published low-priority messages that are discarded after the reject low‑priority message limit for an endpoint has been exceeded.

Replication Is Standby Discard

Number of messages discarded because Guaranteed publishing is not allowed when the Message VPN has a Replication standby state.

Sync Replication Ineligible Discard

Number of messages discarded because the event broker has been configured to reject messages when sync replication mode is ineligible.

Other

Reserved

Egress Spool Discard Statistics:

Messages Deleted

Number of spooled messages the ADB administratively deleted.

Message Expired To Discard

Number of spooled messages that expired and were discarded because no DMQ is configured.

Messages Expired to
#DEAD_MSG_QUEUE

Number of spooled messages that expired and were successfully moved to the DMQ.

Messages Expired to
#DEAD_MSG_QUEUE Failed

Number of spooled messages that expired but were not successfully moved to the DMQ.

These messages are discarded.

Max Redelivery Exceeded to
Discard

The number of spooled messages that were discarded after the maximum number of redelivered attempts were made.

Max Redelivery Exceeded to
#DEAD_MSG_QUEUE

The number of spooled messages that were moved to a DMQ after the maximum number of redelivered attempts were made.

Max Redelivery Exceeded to
#DEAD_MSG_QUEUE Failed

The number of spooled messages that were not able to be moved to a DMQ after the maximum number of redelivered attempts were made.

These messages are discarded.

TTL Exceeded to Discard

The number of messages discarded because the specified maximum Time to Live (TTL) value for a Message VPN bridge (as configured through the max-ttl Bridge CONFIG command) has been exceeded.

Message Processing Statistics:

Number of Ingress Messages

Number of spooled messages the ADB received after subscription matching has completed successfully.

     Promoted to Non-Persistent

Number of Direct messages changed to non‑persistent.

     Demoted to Direct

Number of persistent messages changed to Direct.

     Replicate Promoted

Number of Direct messages changed to non‑persistent and then sent to a Replicated Message VPN.

     Async Replicated

Number of messages in replicate async mode.

     Sync Replicated

Number of messages in replicate sync mode.

     From Replication Mate

Number of messages received from replicate mate.

Sequenced Topic Matches

Number of messages that matched a configured sequenced topic.

Sequence Number Already Assigned

Messages received with a sequence number already present, or that has matched multiple sequenced topics.

Sequence Number Rollover

Messages where the sequence number rolled over from (263 – 1) back to 1.

Sequence Numbered Messages
Discarded

Messages that matched a sequenced topic but were subsequently discarded.

Transacted Messages Not
Sequenced

Messages that matched a sequenced topic but did not have a sequence number applied because they were part of a transacted session.

Ingress Messages Discarded

Number of messages that could not be spooled and were discarded by the ADB at ingress.

Messages Spooled to ADB

Number of spooled messages sent to the ADB.

Messages Spooled To Disk

Number of spooled messages sent to disk for spooling.

Messages Retrieved From ADB

Number of spooled messages that were retrieved from the ADB. Deleted messages are also included in the count.

Messages Retrieved From Disk

Number of spooled messages retrieved from disk. Deleted messages are also included in this count.

Guaranteed Message Cache Miss

Number of messages that could not use optional NAB caching feature.

Messages Ingress Selector
Examined

Number of spooled messages examined by ingress selectors on topic endpoints.

Messages Selector Matched

Number of spooled messages that matched a selector.

Messages Selector Did Not Match

Number of spooled messages that did not match a selector.

Messages Egress Selector
Examined

Number of spooled messages examined by egress selectors on browser and consumer flows.

     Messages Selector Matched

Number of spooled messages that matched a selector.

     Messages Selector Did Not
     Match

Number of messages that did not match a selector.

Egress Messages Discarded

Number of messages discarded at egress.

Number of Egress Messages

Number of messages sent from the spool. Note that one message sent to multiple clients is counted as a single egress message.

     Redelivered

Number of spooled messages sent more than once.

Messages Confirmed Delivered

Number of spooled messages acknowledged by clients and neighboring event brokers.

     Store and Forward

Number of spooled messages that used store and forward delivery (the default) that are acknowledged by clients and neighboring event brokers.

     Cut Through

Number of spooled messages that used cut‑through delivery that are acknowledged by clients and neighboring event brokers.

     From Replication Mate

Number of spooled messages received from a replication mate that are acknowledged by clients and neighboring event brokers.

Transacted Session Processing Statistics:

Open Session

Number of attempts to open transacted sessions.

     Success

Number of transacted sessions successfully created.

     Max Sessions Exceeded

Number of times transacted sessions were not opened because the system limit for the maximum number of transacted sessions was exceeded.

     Other

 

     Success

Number of transacted sessions successfully created.

Transactions

Number of attempts to create local transactions.

     Success

Number of transactions successfully created. The number of transactions committed and rolled back are listed.

     Fail

Number of failures to create a transaction.

     Msgs Published

Number of messages published through a successfully committed transaction.

     Msgs Consumed

Number of messages consumed through a successfully committed transaction.

     Max Transactions Exceeded

Number of times the system limit for the maximum number of transactions was exceeded.

     Max Transaction Resources Exceeded

Number of times the system resources allocated for transactions was exceeded.

XA Transaction Processing Statistics:

Open Session

Number of attempts to open XA Sessions.

     Success

Number of transacted sessions successfully created.

     Max Sessions Exceeded

Number of times XA sessions were not opened because the system limit for the maximum number of XA sessions was exceeded

     Other

 

Transaction Requests

Number of XA requests made. Within this category, the number of requests that succeed and fail are provided. Each type of request that succeeds fails is also provided.

Msgs Spooled to ADB

Number of messages in XA transactions that were spooled to the ADB.

Msgs Retrieved from ADB or Disk

Number of messages in XA transactions that retrieved from the ADB or disk.

Msgs Published

Number of messages published through a successfully committed XA transaction.

Msgs Consumed

Number of messages consumed through successfully committed XA transactions.

Max Transactions Exceeded

Number of times the system limit for the maximum number of XA transactions was exceeded.

Max Transaction Resources      Exceeded

Number of times the system resources allocated for XA transactions was exceeded.

Clearing Message Spool Statistics

To clear the statistics for spooled messages on event brokers, enter the following Privileged EXEC command:

solace# clear message-spool stats

Client Message Spool Information

To show the client message spool configuration and status, enter the following User EXEC command:

solace> show client <name> message-spool [{ingress | egress} [flow <flow-id>]]

Where:

<name> is the full name of the client, or part of the client name with the wildcard character ? used to represent one character of the name, or the wildcard character * used to represent zero or more characters of the name, where entering only the wildcard character * for the name displays all clients.

ingress specifies to show ingress message spool information and statistics.

egress specifies to show egress message spool information and statistics.

flow specifies to show the message flow identifier associated with an ingress or egress message flow.

<flow-id> is the integer identifying the ingress or egress message flow. Valid values are 0 through 16383.

Client Message Spool Statistics

To show the client message spool statistics, enter the following User EXEC command:

solace> show client <name> message-spool-stats [{ingress | egress} [flow <flow-id>]]

Where:

<name> is the full name of the client, or part of the client name with the wildcard character ? used to represent one character of the name, or the wildcard character * used to represent zero or more characters of the name, where entering only the wildcard character * for the name displays all clients.

ingress specifies to show ingress message spool information and statistics.

egress specifies to show egress message spool information and statistics.

flow specifies to show the message flow identifier associated with an ingress or egress message flow.

<flow-id> is the integer identifying the ingress or egress message flow. Valid values are 0 through 16383.

Examples:

Detailed spooled message statistics summary screen for the specific client named s1 (these statistics relate to the number of bytes spooled for the client):

solace> show client clientAck10001 message-spool-stats ingress

 

Primary Virtual Router:

 

Client:                clientAck10001

Type:                  Primary

Client Profile:        default

ACL Profile:           default

Subscriptions:         0

No Local Delivery:     No

Eliding Enabled:       No

Eliding Topics:

  Current:             0

  High Water Mark:     0

Deliver To One:

  Local Priority:      1

  Network Priority:    1

Client Id:             6

Message VPN:           default

Uptime:                0d 0h 1m 4s

Slow Subscriber:       Yes

Client Username:       clientAck

User:                  'rszheng'  Computer: 'dev517'  Process ID: 22013

Description:

Software Version:      6.0.0.11

Software Date:         Oct 19 2012 17:04:39

Platform:              Linux26-i386_opt - C SDK

One Shot Events:

  Large Message:       not raised

  Message Too Big:     not raised

  Parse Error:         not raised

  Max Eliding Topics:  not raised

Total Ingress Flows:   1

Total Egress Flows:    1

Web Transport Session: N/A

SSL Version:           N/A

SSL Cipher:            N/A

 

Message Spool

 

  Ingress Flow Statistics

 

    Client Publish Open Statistics

      Client Publish Open Requests:          1

      Client Publish Open Responses:         1

        OK:                                  1

        Exceeded Clients:                    0

        Denied Guaranteed Messages:          0

        Other:                               0

 

      Session Flow Name:                    c6d2e3c21d7b41e8bec73b7a8dc00741

      Flow ID:                              2104

      Publisher ID:                         1

 

    Discard Statistics

      Spooling Not Ready:                   0

      Out of Order Messages:                0

      Duplicate Messages:                   0

      No Eligible Destinations:             0

      Spool Over Quota:                     0

      Queue/Topic-Endpoint Over Quota:      0

      Max. Message Usage Exceeded:          0

      Max. Message Size Exceeded:           0

      Remote Router Spooling Not Supported: 0

      Spool To ADB Fail:                    0

      Spool To Disk Fail:                   0

      Spool File Limit Exceeded:            0

      Errored Message:                      0

      Queue Not Found:                      0

      Spool Shutdown:                       0

      User Profile Deny Guaranteed:         0

      No Local Delivery:                    0

      TTL Exceeded:                         0

      Publish ACL Denied:                   0

      Destination Group Error:              0

      Not Compatible With Forwarding Mode:  0

      Low-Priority-Msg Congestion Discard:  0

 

    Processing Statistics

      Last Message Id Sent:                 250757

      Window Size:                          50

      Guaranteed Messages:                  250000

      Sequenced Topic Matches:              0

      Sequence Number Already Assigned:     0

      Sequence Number Rollover:             0

      Sequence Numbered Messages Discarded: 0

      Transacted Messages Not Sequenced:    0

 

solace> show client s1 message-spool-stats egress

 

Primary Virtual Router:

 

Client:                clientAck10001

Type:                  Primary

Client Profile:        default

ACL Profile:           default

Subscriptions:         0

No Local Delivery:     No

Eliding Enabled:       No

Eliding Topics:

  Current:             0

  High Water Mark:     0

Deliver To One:

  Local Priority:      1

  Network Priority: 1

Client Id:             11

Message VPN:           default

Uptime:                0d 0h 0m 1s

Slow Subscriber:       No

Client Username:       clientAck

User:                 'rszheng' Computer: 'dev617' Process ID: 22013

Description:

Software Version:      6.0.0.11

Software Date:         Oct 19 2012 17:04:39

Platform:              Linux26-i386_opt - C SDK

One Shot Events:

  Large Message:       not raised

  Message Too Big:     not raised

  Parse Error:         not raised

  Max Eliding Topics:  not raised

Total Ingress Flows:   1

Total Egress Flows:    1

Web Transport Session: N/A

SSL Version:           N/A

SSL Cipher:            N/A

 

Message Spool

 

  Egress Flow Statistics

 

    Client Bind Statistics

      Client Bind Requests:                  1

      Client Bind Responses:                 1

        OK:                                  1

        Already Bound:                       0

        Exceeded Clients:                    0

        Queue/TE Shutdown:                   0

        Denied Guaranteed Messages:          0

        Denied Cut-Through Forwarding:       0

        Invalid Selector:                    0

        Other:                               0

 

    Flow Id (State):                         15 (Deliver from ADB or Disk)

      Transport Statistics

        Window Size:                         255

       Used Window:                         129

          Low Message Id AckPending:         126578

          High Message Id AckPending:        126706

        Window Closed:                       154

        Message Redelivered:                 98205

      Application Statistics

        Message Confirmed Delivered:         0

          Store and Forward:                 0

          Cut-Through:                       0

        Unacked Messages:                    98076

        Max Delivered Unacked Msgs Exceeded: 0

Clearing Client Message Spool Statistics

To clear the message spool statistics database for all clients on an event broker, run the following Privileged EXEC command:

solace> enable
solace# clear message-spool-stats

XA Transaction Statistics

solace> show xa-transaction [xid <xid>] [message-vpn <vpn-name>] [state <transaction-state>] [detail | sort-by-last-state-change | sort-by-messages-spooled]

Where:

<xid> is the Xid that uniquely identifies an XA transaction and the global transaction it is associated with. The wildcards * or ? may be used.

<vpn-name> is the name of the Message VPN that the XA transaction is in. The Message VPN name can contain from 1 to 32 characters. The wildcards * or ? may be used.

<transaction-state> specifies to show XA transactions with a specific state. If not specified, all states are included. The wildcards * or ? may be used.

detail specifies to show detailed information on the XA transactions.

sort-by-last-state-change specifies to sort the listed XA transactions according to the last state change in descending order.

sort-by-messages-spooled specifies to sort the display output for number of messages spooled in descending order.

The table below lists the information that may be displayed in spooled message statistics. Some of this information is only displayed when detailed statistics are requested.

XA Transactions Statistics

Statistic

Description

XA Session

The name of associated transacted session. If there is no associated session, then this field is
N/A.

Session ID

The Id of the associated transacted session. If there is no associated session, then this field is
N/A.

Idle Timeout

The number of seconds before an idle transaction may be automatically rolled back and freed.

Last State Change

The elapsed time since the last state change.

This does not include a status change from in-progress to complete, but only the time since entering the state.

State

The following states are possible for an XA transaction:

ACTIVE—The transaction is associated to a transacted session.

MARKED_ROLLBACK—The transaction is active and marked as rollback-only.

IDLE—The transaction is not associated to any transacted session and will be rolled back if not prepared, committed, or rolled back within the idle timeout period.

PREPARING—The transaction is processing a prepare request.

PREPARED—The transaction is prepared and ready for a commit or roll back request.

COMMITTING—The transaction is processing a commit request.

COMMITTED—The transaction is heuristically completed and successfully committed.

ROLLING_BACK—The transaction is processing a rollback request.

ROLLED_BACK—The transaction is heuristically completed and successfully rolled back.

Examples:

solace> show xa-transaction xid 0102* message-vpn default

 

XID                                                                    Messages

Message VPN                             State       Last State Change   Spooled

--------------------------------------- ----------- ----------------- --------

01020304-0123456789ABCDEF-01

default                                 ACTIVE      100d 11h 12m 10s        25

01020304-0123456789ABCDEF-02

default                                 IDLE        0d 0h 0m 11s            25

01020304-0123456789ABCDEF-04

default                                 PREPARED    1d 11h 12m 13s         255

01020304-0123456789ABCDEF-0123456789AB

default                                 COMPLETE    2d 11h 12m 13s           0

01020304‑0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF01234

  56789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF‑123456789ABCDEF1

  23456789ABCDEF123456789ABCDEF123456789ABCDEF123456789ABCDEF123456789ABCDEF12

  3456789ABCDEF123456789ABCDEF

default                                 COMPLETE    0d 11h 12m 13s           0

 

solace> show xa-transaction xid 01020304-0123456789ABCDEF-02 detail

 

XID:                  01020304-0123456789ABCDEF-02

Message VPN:          default

Client:               dev184/13662/#00020002

Client Id:            1

XA Session:           9e36ba351bca478b9f1ccadd0651c218

Session Id:           2

Idle Timeout:         60 sec

State:                PREPARING

Last State Change:    1d 11h 12m 13s

Messages Spooled:     25

Messages Published:   25

Messages Consumed:    1