The log management feature of Simple Message Queue (formerly MNS) pushes message request logs to Simple Log Service (SLS). You can then use the query and analysis features of SLS to troubleshoot issues.
Scenarios
Have you encountered the following issues when you send and receive messages?
A message is sent to a queue, but the consumer cannot receive it. Where did the message go?
Who consumed the message? How many times was it consumed?
The consumer is unavailable. When can a failed message be consumed again?
A message is published to a topic, but the endpoint does not receive it. Why is there a delay?
You can solve these issues using the log management feature of Simple Message Queue (formerly MNS). The methods are as follows:
Push logs to SLS and view the complete message trace in the console.
Use the query tool on the official website. Specify the required parameters to view the message processing logs.
Billing
Simple Message Queue (formerly MNS) does not charge extra fees for the log management feature.
Simple Message Queue (formerly MNS) pushes logs to SLS. SLS charges you based on factors such as storage space, traffic, and the number of requests. For more information, see Billing overview.
Queue log format
Queue message operation logs are generated from operations on queue messages, such as sending, consuming, and deleting messages. Each operation log contains multiple fields. Each field has a specific meaning. The fields included in a log vary depending on the operation. The following sections describe the meaning of each field and list the fields that are included for different operations.
Log field descriptions
Each operation log contains multiple fields. The following table describes these fields.
Field
Description
Time
The time when the operation occurred.
MessageId
The ID of the message that is processed in the operation.
QueueName
The name of the queue for which the operation is performed.
AccountId
The ID of the account that owns the queue.
RemoteAddress
The IP address of the client that initiated the operation.
NextVisibleTime
The next time the message becomes visible after the operation is complete.
ReceiptHandleInRequest
The ReceiptHandle parameter that the client passes in for the operation.
ReceiptHandleInResponse
The ReceiptHandle that is returned to the client after the operation is complete.
ProcessTime
The time it takes to process the operation.
RequestId
The ID of the task.
Action
The action, such as delete or send.
Fields for each operation
The fields included in a log vary depending on the operation. The following table lists the fields for each operation.
Operation
Time
QueueName
AccountId
MessageId
RemoteAddress
NextVisibleTime
ReceiptHandleInResponse
ReceiptHandleInRequest
SendMessage/BatchSendMessage
Yes
Yes
Yes
Yes
Yes.
Yes.
No
None
PeekMessage/BatchPeekMessage
Yes
Yes
Yes
Yes
Yes.
No
No
No
ReceiveMessage/BatchReceiveMessage
Yes.
Yes
Yes
Yes
Yes
Yes
Yes
No
ChangeMessageVisibility
Yes.
Yes
Yes.
Yes
Yes
Yes
Yes
Yes.
DeleteMessage/BatchDeleteMessage
Yes
Yes.
Yes
Yes
Yes
Yes
No
Yes
Topic log format
Topic message operation logs are generated from operations on topic messages. These operations are primarily of two types: publishing messages and pushing messages. The following sections describe the meaning of each field in a topic message operation log and list the fields that are included for different operations.
Log field descriptions
Each operation log contains multiple fields. The following table describes these fields.
Field
Description
Time
The time when the operation occurred.
MessageId
The ID of the message that is processed in the operation.
TopicName
The name of the topic for which the operation is performed.
SubscriptionName
The name of the subscription for which the operation is performed.
AccountId
The ID of the account that owns the topic.
RemoteAddress
The IP address of the client that initiated the operation.
NotifyStatus
The HTTP status code or error information that is returned by the user when Simple Message Queue (formerly MNS) pushes a message.
ProcessTime
The time it takes to process the operation.
MessageTag
The message tag.
RequestId
The ID of the task.
Action
The action, such as delete or send.
Fields for each operation
The fields included in a log vary depending on the operation. The following table lists the fields for each operation.
Operation
Time
MessageId
TopicName
SubscriptionName
AccountId
RemoteAddress
NotifyStatus
Subscription Name
PublishMessage
Yes.
Yes
Yes
No
Yes
Yes
None
No
Notify
Yes
Yes
Yes
Yes
Yes
No
Yes.
Yes
NotifyStatus
NotifyStatus is a field specific to message push logs. This field helps you troubleshoot failures that occur when Simple Message Queue (formerly MNS) pushes messages to an endpoint. You can resolve issues based on the suggestions that are provided in the following table for different NotifyStatus values.
Error code
Description
Suggested solution
2xx
The message is pushed successfully.
None.
Other HTTP status codes
The endpoint returns a non-2xx status code when the message is pushed.
Check the processing logic at the endpoint.
InvalidHost
The endpoint specified in the subscription is invalid.
Confirm that the endpoint in the subscription is valid. You can use curl or telnet to check.
ConnectTimeout
The connection to the endpoint specified in the subscription timed out.
Confirm that the endpoint in the subscription is accessible. You can use curl or telnet to check.
ConnectFailure
Failed to connect to the endpoint specified in the subscription.
Confirm that the endpoint in the subscription is accessible. You can use curl or telnet to check.
UnknownError
An unknown error occurred.
Contact Simple Message Queue (formerly MNS) technical support.
Log management operations
Before you use the log feature, complete the following prerequisites:
Create a queue and a topic in Simple Message Queue (formerly MNS). For more information, see Queue operations and Topic operations.
Create a project and a Logstore in Simple Log Service. For more information, see Manage a project and Create a Logstore.
Your MNS operation logs can only be pushed to an SLS project in the same region.
Grant the AliyunMNSLoggingRole role to MNS to export logs.
Click Cloud Resource Access Authorization and follow the on-screen instructions to grant the permissions.
WarningDo not revoke the authorization or delete the RAM role. Otherwise, Simple Message Queue (formerly MNS) logs cannot be pushed to Simple Log Service.
Enable or disable the log feature
Enable/disable the queue logging feature
Log on to the SMQ console.
In the navigation pane on the left, click Queue List.
In the top menu bar, select a region.
On the Queue List page, find the target queue. In the Actions column, click the
> Edit.In the Edit Queue Parameters panel, turn on or turn off the Enable Logging switch.
On the Queue List page, the Logging column for the target queue displays Enabled or Disabled.
Enable/disable the logging feature for a subject
Push logs to Simple Log Service
View logs
Log on to the Simple Log Service console.
In the Projects section, click the one you want.
On the tab, click the logstore you want.
Enter a search statement, click Last 15 Minutes, and then set a time range for the query. For more information, see Quick start for search and analysis.
Log analysis examples
Query the trace of a queue message
This example shows how to query the trace of a queue message. Enter the queue name and message ID. The format of the search statement is $QueueName and $MessageId, for example, log and EED287A265726135146E6A9CADC8XXXX.
The following figure shows the query result. The result records the lifecycle of the message from the time it is sent to the time it is received.
Query the trace of a topic message
This example shows how to query the trace of a topic message. Enter the topic name and message ID. The format of the search statement is $TopicName and $MessageId, for example, logtest and 8798453B65727FC6433E6AB4F746XXXX.
The following figure shows the query result. The result records the lifecycle of the message from the time it is sent to the time it is delivered.
Query the number of sent queue messages
This example shows how to query the number of sent queue messages. Enter the queue name and the send operation. The format of the search statement is $QueueName and (SendMessage or BatchSendMessage), for example, log and (SendMessage or BatchSendMessage).
The following figure shows the query result. Within the specified time range, the producer sent three messages to the log queue.
Query the number of sent topic messages
This example shows how to query the number of sent topic messages. Enter the topic name and the publish operation. The format of the search statement is $TopicName and PublishMessage, for example, logtest and PublishMessage.
The following figure shows the query result. Within the specified time range, the producer sent three messages to the logtest topic.
Query the number of consumed queue messages
This example shows how to query the number of consumed queue messages. Enter the queue name and the consume operation. The format of the search statement is $QueueName and (ReceiveMessage or BatchReceiveMessage), for example, log and (ReceiveMessage or BatchReceiveMessage).
The following figure shows the query result. Within the specified time range, 12 messages in the log queue were consumed.
Query the number of deleted queue messages
This example shows how to query the number of deleted queue messages. Enter the queue name and the delete operation. The format of the search statement is $QueueName and (DeleteMessage or BatchDeleteMessage), for example, log and (DeleteMessage or BatchDeleteMessage).
The following figure shows the query result. Within the specified time range, 61 messages in the log queue were deleted.
Query the number of messages processed by a client
This example shows how to query the number of messages processed by a specific client. Enter the client IP address. The format of the search statement is $ClientIP, for example, 10.10.10.0.
If you want to query the logs of a specific operation for a client, you can use a combination of keywords, for example, $ClientIP and (SendMessage or BatchSendMessage).
The following figure shows the query result. Within the specified time range, the client processed 66 messages.