Displaying and Clearing Logs

You can display the following types of Solace PubSub+ event broker logs:

You can also clear ACL, no-subscription-match, or REST logs:

ACL Logs

Access control lists (ACLs) are used to manage clients’ access to the Solace PubSub+ event broker and the topics to which they are permitted to publish and subscribe. For more information, refer to Controlling Which Topics a Client May Publish and Subscribe To.

:  ACL logs are not maintained after an event broker restarts.

To display the most recent 1,000 ACL log entries, enter the following User EXEC command:

solace> show log acl [client-connect | publish-topic | subscribe-topic] [client-username <username>] [message-vpn <vpn-name>] [wide]

Where:

client-connect shows only logs relating to client-connect ACLs.

publish-topic shows only logs relating to publish-topic ACLs.

subscribe-topic shows only logs relating to subscribe-topic ACLs.

client-username <username> specifies the client username. This value may contain wildcards.

message-vpn <vpn-name> is the Message VPN name. The wildcards * or ? may be used.

wide generates the output log in a wide format.

Command Logs

Command logs capture information about Solace PubSub+ event broker commands issued by users. For more information, refer to Managing Command Logging.

To display access user command logs, enter the following User EXEC command:

solace> show log command [lines <num-lines>] [find <search-string>]

Where:

lines <num-lines> specifies the number of lines to read. The default is 1000.

find <search-string> specifies a string to use as a filter. No filtering is applied by default.

Event Logs

To display Solace PubSub+ event broker event logs, enter the following User EXEC command:

solace> show log event [lines <num-lines>] [find <search-string>]

Where:

lines <num-lines> specifies the number of lines to read. The default is 1000.

find <search-string> specifies a string to use as a filter. No filtering is applied by default.

System Logs

System logs are a subset of event broker event logs that are duplicated into system.log. This provides a method for logging important system events in high‑event environments. The Event Reference specifies which events are duplicated into system.log.

To display Solace PubSub+ event broker system logs, enter the following User EXEC command:

solace> show log system [lines <num-lines>] [find <search-string>]

Where:

lines <num-lines> specifies the number of lines to read. The default is 1000.

find <search-string> specifies a string to use as a filter. No filtering is applied by default.

No-Subscription-Match Logs

When a client publishes Direct or Guaranteed messages, a no-subscription-match statistic is logged for each message that doesn't match a topic subscription.

:  Messages that match a configured sequenced topic aren't recorded as a no-subscription-match even if they don't match a subscription. All other messages that don't match subscriptions are logged, including messages that only match a replicated topic subscription.

To display the most recent 1000 no-subscription-match logs, enter the following User EXEC command:

solace> show log no-subscription-match [client-username <username>][client-name <name>] [message-vpn <vpn-name>] [wide]

Where:

client-username <username> specifies show only logs for the given client username. A username can contain up to 189 printable ASCII characters (that is, characters in the range 0x20 – 0x7e) and is case-sensitive. The provided username may contain the wildcards * or ?.

client-name <name> specifies to show only logs for a client matching the given name.

message-vpn <vpn-name> is the Message VPN name.

wide outputs the log in a wide format.

  • no-subscription-match logs aren't maintained after an event broker restarts.
  • For a username, client name, or Message VPN name, you can enter a full name, or part of a name, with either 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.

REST Logs

To display Solace PubSub+ event broker REST logs, enter the following User EXEC command:

solace> show log rest [rest-delivery-point] [errors] [wide]

Where:

rest-delivery-point show logs for REST Delivery Points.

errors show logs for error responses.

wide outputs the log in a wide format.

Clearing Event Broker Logs

To clear ACL, no-subscription-match, or REST logs, enter the following Privileged EXEC command:

solace# clear log [acl][no-subscription-match][rest]

Where:

acl clears the current ACL log entries

no-subscription-match clears any no-subscription-match log entries

rest clears REST log entries