SMQ log management - query and analyze message request logs - Simple Message Queue (formerly MNS)

La función de gestión de registros de Simple Message Queue (SMQ) envía los registros de solicitudes de mensajes a Simple Log Service (SLS). Posteriormente, puede utilizar SLS para consultar y analizar estos registros con el fin de solucionar problemas en producción.

Casos de uso

A continuación se presentan algunos problemas comunes al enviar y recibir mensajes:

Un mensaje se envía correctamente a una cola, pero el cliente consumidor no lo recibe. ¿Qué ocurrió con el mensaje?
¿Quién consumió un mensaje específico? ¿Cuántas veces se consumió?
Un cliente consumidor falla. ¿Cuándo se podrá consumir de nuevo un mensaje cuyo consumo falló?
Se publica un mensaje en un tema, pero el endpoint no lo ha recibido después de mucho tiempo. ¿Cuál es la causa del retraso?

La gestión de registros en SMQ resuelve estas situaciones:

Envíe los registros a SLS y consulte la traza completa del mensaje en la consola.
Utilice la herramienta de consulta disponible en el sitio web oficial. Especifique los parámetros necesarios para ver los registros de procesamiento de mensajes.

Facturación

SMQ no cobra tarifas adicionales por la función de gestión de registros.
Cuando SMQ envía registros a SLS, este último le cobra según el espacio de almacenamiento, el tráfico y el volumen de solicitudes. Billing overview.

Formato de los registros de colas

Las operaciones con mensajes de cola (enviar, consumir y eliminar) generan entradas de registro. Los campos incluidos varían según la operación.

Campos de registro

Las entradas de registro de colas pueden incluir los siguientes campos.

Campo	Descripción
Time	Marca de tiempo de la operación.
MessageId	Identificador único del mensaje.
QueueName	Nombre de la cola de destino.
AccountId	Identificador de la cuenta propietaria de la cola.
RemoteAddress	Dirección IP del cliente.
NextVisibleTime	Momento en que el mensaje vuelve a estar visible.
ReceiptHandleInRequest	`ReceiptHandle` proporcionado por el cliente.
ReceiptHandleInResponse	`ReceiptHandle` devuelto al cliente.
ProcessTime	Tiempo de procesamiento de la operación.
RequestId	Identificador de la solicitud.
Action	Acción ejecutada, como `DeleteMessage` o `SendMessage`.

Campos por operación

En la siguiente tabla se muestran los campos que incluye cada operación.

Operación	Time	QueueName	AccountId	MessageId	RemoteAddress	NextVisibleTime	ReceiptHandleInResponse	ReceiptHandleInRequest
SendMessage/BatchSendMessage	Sí	Sí	Sí	Sí	Sí	Sí	No	No
PeekMessage/BatchPeekMessage	Sí	Sí	Sí	Sí	Sí	No	No	No
ReceiveMessage/BatchReceiveMessage	Sí	Sí	Sí	Sí	Sí	Sí	Sí	No
ChangeMessageVisibility	Sí	Sí	Sí	Sí	Sí	Sí	Sí	Sí
DeleteMessage/BatchDeleteMessage	Sí	Sí	Sí	Sí	Sí	Sí	No	Sí

Formato de los registros de temas

Las operaciones con mensajes de tema (publicar y enviar) generan entradas de registro. Los campos incluidos varían según la operación.

Campos de registro

Las entradas de registro de temas pueden incluir los siguientes campos.

Campo	Descripción
Time	Marca de tiempo de la operación.
MessageId	Identificador único del mensaje.
TopicName	Nombre del tema de destino.
SubscriptionName	Nombre de la suscripción.
AccountId	Identificador de la cuenta propietaria del tema.
RemoteAddress	Dirección IP del cliente.
NotifyStatus	Código de estado o error devuelto por el endpoint cuando SMQ envía un mensaje.
ProcessTime	Tiempo de procesamiento de la operación.
MessageTag	Etiqueta del mensaje.
RequestId	Identificador de la solicitud.
Action	Acción ejecutada, como `PublishMessage` o `Notify`.

Campos por operación

En la siguiente tabla se muestran los campos que incluye cada operación.

Operación	Time	MessageId	TopicName	SubscriptionName	AccountId	RemoteAddress	NotifyStatus	MessageTag
PublishMessage	Sí	Sí	Sí	No	Sí	Sí	No	No
Notify	Sí	Sí	Sí	Sí	Sí	No	Sí	Sí

NotifyStatus

El campo NotifyStatus en los registros de envío indica por qué SMQ no pudo entregar un mensaje. Solucione el problema con base en los siguientes valores.

Código de error	Descripción	Acción recomendada
2xx	El mensaje se envió correctamente.	Ninguna.
Otros códigos de estado HTTP	El endpoint devolvió un código de estado distinto de 2xx.	Revise la lógica de procesamiento en su endpoint.
InvalidHost	Endpoint de suscripción no válido.	Compruebe que el endpoint de suscripción sea válido y accesible mediante `curl` o `telnet`.
ConnectTimeout	Se agotó el tiempo de espera de la conexión con el endpoint de suscripción.	Compruebe que el endpoint de suscripción sea accesible mediante `curl` o `telnet`.
ConnectFailure	La conexión con el endpoint de suscripción falló.	Compruebe que el endpoint de suscripción sea accesible mediante `curl` o `telnet`.
UnknownError	Ocurrió un error desconocido.	Póngase en contacto con el soporte técnico de SMQ.

Operaciones con registros

Antes de usar la gestión de registros, asegúrese de cumplir con lo siguiente:

Cree una cola y un tema en SMQ. Manage queues. Manage topics.

Cree un proyecto y un logstore en SLS. Manage a Project. Create a Logstore.

Los registros de operaciones de su servicio SMQ solo se pueden enviar a un Project de SLS ubicado en la misma región.
Autorice a SMQ para exportar registros mediante el rol de RAM AliyunMNSLoggingRole.

Haga clic en Cloud Resource Access Authorization y siga las instrucciones en pantalla para completar la autorización.

Aviso
No revoque la autorización ni elimine el rol de RAM. De lo contrario, los registros de SMQ no se podrán enviar a SLS.

Habilitar o deshabilitar el registro

Habilitar o deshabilitar el registro de colas

Inicie sesión en la consola de Simple Message Queue (anteriormente MNS).
En el panel de navegación izquierdo, haga clic en Queues.
En la barra de menú superior, seleccione una región.
En la página Queues, busque la cola de destino. En la columna Actions, elija > Edit.
En el panel Edit Queue Parameters, active o desactive el interruptor Enable Logging Feature.

En la página Queues, la columna Logging de la cola de destino mostrará Enabled o Disabled.

Habilitar o deshabilitar el registro de temas

Inicie sesión en la consola de Simple Message Queue (anteriormente MNS).
En el panel de navegación izquierdo, haga clic en Topics.
En la barra de menú superior, seleccione una región.
En la página Topics, busque el tema de destino y haga clic en Edit en la columna Actions.
En el panel Edit Topic Parameters, active o desactive el interruptor Enable Logging Feature.

En la página Topics, la columna Logging del tema de destino mostrará Enabled o Disabled.

Enviar registros a SLS

Procedimiento

Inicie sesión en la consola de Simple Message Queue (anteriormente MNS).
En el panel de navegación izquierdo, haga clic en Logging.
En la barra de menú superior, seleccione una región.
En la página Logging, dentro de la pestaña Select Target, seleccione Simple Log Service (SLS).
En la pestaña Configure Target, seleccione un Project Name y un Logstore Name, y luego haga clic en Enable.

La página Logging mostrará el Project y el logstore configurados.

Consultar registros

Procedimiento

Inicie sesión en la consola de Simple Log Service.
En la sección Projects, haga clic en el proyecto que desee.
En la pestaña Log Storage > Logstores, haga clic en el logstore de destino.
Introduzca una instrucción de consulta y haga clic en Last 15 Minutes para establecer el intervalo de tiempo. Quick start for search and analysis.

Ejemplos de análisis de registros

Consultar la traza de un mensaje de cola

Para rastrear un mensaje de cola, realice la búsqueda por nombre de cola e identificador de mensaje: $QueueName and $MessageId. Por ejemplo: log and EED287A265726135146E6A9CADC8XXXX.

El resultado muestra el ciclo de vida del mensaje, desde el envío hasta la recepción.

Ambas entradas de registro comparten el mismo MessageId. La entrada 5 corresponde a la operación SendMessage, mientras que la entrada 4 corresponde a la operación ReceiveMessage.

4  10-21 16:50:57  MNSLogging  1603270323

  NextVisibleTime :1603270287
  ProcessTime :2
  ReceiptHandleInResponse :8-BBMzv7glMLMzuzazpcz0z6GXz23TAhoSh7bA
  Time :2020-10-21 16:50:57.097000
  AccountId :1xxx xxx5
  Action :ReceiveMessage
    MessageId :EED287A265726135146E6A9CADC8xxx
    RequestId :5F8FF671454539F442BF7CE9
    RemoteAddress :1xxx xxx4
    QueueName :sgw-express-sync-queue-gw-0008q1m4pv7qjse4na31-5796

5  10-21 16:50:53  MNSLogging  1603270327

  NextVisibleTime :1603270253
  ProcessTime :1
  Time :2020-10-21 16:50:53.001000
  AccountId :17xxx xxx2745
  Action :SendMessage
    MessageId :EED287A265726135146E6A9CADC8xxx
    RequestId :5F8FF66D3030359405DF281F
    RemoteAddress :xxx xxx1
    QueueName :sgw-express-sync-queue-gw-0008q1m4pv7qjse4na31-5796

Consultar la traza de un mensaje de tema

Para rastrear un mensaje de tema, realice la búsqueda por nombre de tema e identificador de mensaje: $TopicName and $MessageId. Por ejemplo: logtest and 8798453B65727FC6433E6AB4F746XXXX.

El resultado muestra el ciclo de vida del mensaje, desde la publicación hasta la notificación.

4  10-21 16:50:57  MNSLogging  1603270323

  NextVisibleTime :1603270287
  ProcessTime :2
  ReceiptHandleInResponse :8-BBMzv7glMLMzuzazpcz0z6GXz23TAhoSh7bA
  Time :2020-10-21 16:50:57.097000
  AccountId :1xxx xxx5
  Action :ReceiveMessage
    MessageId :EED287A265726135146E6A9CADC8xxx
    RequestId :5F8FF671454539F442BF7CE9
    RemoteAddress :1xxx xxx4
    QueueName :sgw-express-sync-queue-gw-0008q1m4pv7qjse4na31-5796

5  10-21 16:50:53  MNSLogging  1603270327

  NextVisibleTime :1603270253
  ProcessTime :1
  Time :2020-10-21 16:50:53.001000
  AccountId :17xxx xxx2745
  Action :SendMessage
    MessageId :EED287A265726135146E6A9CADC8xxx
    RequestId :5F8FF66D3030359405DF281F
    RemoteAddress :xxx xxx1
    QueueName :sgw-express-sync-queue-gw-0008q1m4pv7qjse4na31-5796

Consultar mensajes de cola enviados

Para consultar los mensajes enviados a una cola, utilice el nombre de la cola y la operación de envío: $QueueName and (SendMessage or BatchSendMessage). Por ejemplo: log and (SendMessage or BatchSendMessage).

Después de introducir la instrucción de consulta y establecer el intervalo de tiempo (por ejemplo, Last 15 Minutes (Relative)), haga clic en Query/Analyze. El resultado de la consulta muestra que un productor envió tres mensajes a la cola "log" dentro del intervalo de tiempo especificado. Cada entrada de registro contiene campos como Action, QueueName, MessageId, RequestId y AccountId.

Consultar mensajes de tema publicados

Para consultar los mensajes publicados en un tema, utilice el nombre del tema y la operación de publicación: $TopicName and PublishMessage. Por ejemplo: logtest and PublishMessage.

Al ejecutar la consulta, los resultados muestran que un productor publicó tres mensajes en el tema "logtest" dentro del intervalo de tiempo especificado. Cada entrada de registro contiene campos como TopicName (valor: logtest), Action (valor: PublishMessage), ProcessTime, Time, AccountId, MessageId, RequestId, RemoteAddress y MessageTag.

Consultar mensajes de cola consumidos

Para consultar los mensajes consumidos de una cola, utilice el nombre de la cola y la operación de consumo: $QueueName and (ReceiveMessage or BatchReceiveMessage). Por ejemplo: log and (ReceiveMessage or BatchReceiveMessage).

Al ejecutar la consulta, los resultados muestran que se consumieron 12 mensajes de la cola "log" dentro del intervalo de tiempo especificado. En los detalles del registro, el campo Action es ReceiveMessage y el campo QueueName es log, lo cual confirma que se encontraron los registros de consumo de la cola indicada.

Consultar mensajes de cola eliminados

Para consultar los mensajes eliminados de una cola, utilice el nombre de la cola y la operación de eliminación: $QueueName and (DeleteMessage or BatchDeleteMessage). Por ejemplo: log and (DeleteMessage or BatchDeleteMessage).

Haga clic en Query/Analyze. El resultado de la consulta muestra que se eliminaron 61 mensajes de la cola "log" dentro del intervalo de tiempo especificado. En los detalles del registro, el campo Action es DeleteMessage y el campo QueueName es log.

Consultar mensajes por cliente

Para consultar los mensajes procesados por un cliente específico, utilice la dirección IP del cliente: $ClientIP. Por ejemplo: 10.10.10.0.

Para filtrar por tipo de operación, combine palabras clave. Por ejemplo: $ClientIP and (SendMessage or BatchSendMessage).

Después de introducir la instrucción de consulta, haga clic en Query/Analyze y use el selector de tiempo de la derecha para establecer el intervalo de tiempo (por ejemplo, Last 15 Minutes (Relative)). El resultado de la consulta muestra que el cliente procesó 66 mensajes dentro del intervalo de tiempo especificado. La página muestra el estado Query Results como Precise junto con el valor de Log Count, y el histograma de resultados ilustra la distribución de los registros a lo largo del tiempo.