Parameters, billing, and query methods - ApsaraMQ for RocketMQ

Cas d'utilisation

ApsaraMQ for RocketMQ définit des points de données clés dans le cycle de vie des messages en tant que paramètres de trace et met à disposition un outil de requête visuel. Les traces de messages vous permettent de comprendre rapidement l'état de vos processus métier et d'identifier les exceptions.

Les cas d'utilisation typiques des traces de messages sont les suivants :

Scénario 1 : Vérifier si un message a été envoyé ou consommé avec succès.
Scénario 2 : Vérifier si un message planifié et différé a été livré.
Scénario 3 : Vérifier si un message transactionnel a été validé ou annulé.
Scénario 4 : Consulter l'identité du producteur et du consommateur ainsi que les informations sur les machines pour enquêter sur les problèmes.

Paramètres de trace

Le tableau suivant décrit les paramètres de trace fournis par ApsaraMQ for RocketMQ.

Catégorie	Paramètre	Description
Producteur	Informations sur le producteur	Le compte ou l'ID AccessKey utilisé par le producteur de messages.
	Nom d'hôte	Le nom d'hôte de la machine du client producteur.
	Envoyé à	L'heure à laquelle le producteur a envoyé le message.
	Arrivé à	L'heure à laquelle le message a été stocké sur le serveur ApsaraMQ for RocketMQ.
	Résultat de l'envoi	Le résultat de l'opération d'envoi du message. Valeurs possibles : Envoyé Échec
Informations de base sur le message	Type de message	Messages normaux Messages ordonnés Messages planifiés et différés Messages transactionnels
	ID de message	Un identifiant de message unique au niveau mondial, généré automatiquement par ApsaraMQ for RocketMQ.
	Topic	Le topic auquel appartient le message.
	Clé de message	Une clé métier définie par le producteur pour identifier de manière unique une logique métier.
	Tag de message	Un tag utilisé pour filtrer les messages au sein d'un topic.
Messages ordonnés	MessageGroup	Le MessageGroup défini par le producteur pour un message ordonné. Les messages appartenant au même MessageGroup sont traités selon l'ordre premier entré, premier sorti (FIFO).
Messages transactionnels	Heure du rappel de vérification	L'heure du rappel de vérification de l'état de la transaction pour un message semi-validé.
	Validé à	L'heure à laquelle le serveur a validé le message transactionnel.
	Annulé à	L'heure à laquelle le message transactionnel a été annulé.
Messages planifiés	Délai prédéfini	L'heure de livraison planifiée pour le message.
Consommateur	Résultat de la consommation	Le résultat d'une tentative de consommation. Valeurs possibles : Consommé Échec Aucune réponse
	Informations sur le consommateur	Le compte ApsaraMQ for RocketMQ ou l'ID AccessKey que le consommateur utilise pour s'abonner aux messages.
	Nom d'hôte	Le nom d'hôte de la machine du client consommateur.
	Livraison ordonnée	Indique si la consommation ordonnée est activée pour le groupe du consommateur.
	Heure de livraison	L'heure à laquelle le serveur ApsaraMQ for RocketMQ a livré le message au consommateur.
	Heure de réponse	L'heure à laquelle le serveur ApsaraMQ for RocketMQ a reçu le résultat de la consommation du consommateur.
	invisibleDuration	La durée d'invisibilité du message spécifiée par le SimpleConsumer. Pour plus d'informations, consultez Politique de nouvelle tentative de consommation SimpleConsumer.
	Modifier la durée d'invisibilité	L'heure à laquelle le SimpleConsumer a appelé l'opération ChangeInvisibleDuration.
	Heure de mise en file d'attente des messages morts	L'heure à laquelle un message a été envoyé à la file d'attente des messages morts après l'échec de la consommation.

Limites

La fonctionnalité de trace des messages est désactivée par défaut pour les clients utilisant les SDK RocketMQ 4.x/3.x. Pour interroger les traces de messages dans la console, vous devez activer cette fonctionnalité dans votre code. Configurez les paramètres suivants :

Producteur

producer.setAccessChannel(AccessChannel.CLOUD);

Consommateur

consumer.setAccessChannel(AccessChannel.CLOUD);

Facturation

Pour les instances par abonnement et à la demande, la trace des messages est activée par défaut et gratuite.
Pour les instances serverless, vous pouvez activer ou désactiver manuellement la trace des messages. Pour plus d'informations, consultez Activer ou désactiver la trace des messages pour une instance serverless.

Si vous activez la trace des messages pour une instance serverless, vous êtes facturé en fonction du nombre de traces de messages générées. Pour les détails de facturation, consultez Frais de trace des messages.

Période de rétention des traces de messages

Pour les instances par abonnement et à la demande, les traces de messages sont conservées pendant 3 jours.
Pour les instances serverless, les traces de messages sont conservées pendant 14 jours.

Méthodes de requête pour les traces de messages

ApsaraMQ for RocketMQ prend en charge les méthodes de requête suivantes :

Requête par ID de message : effectue une correspondance exacte. Cette méthode rapide et précise est recommandée.
Requête par clé de message : cette méthode effectue une recherche floue qui renvoie jusqu'à 1 000 traces. Utilisez cette méthode uniquement si vous n'avez pas enregistré l'ID du message mais avez défini une clé de message distincte.
Requête par topic : effectue une requête par plage. Cette méthode convient aux scénarios à faible volume où l'ID du message ou la clé du message est inconnue. Elle n'est pas recommandée pour une utilisation générale car une plage de temps peut contenir de nombreux messages non distincts.

Activer ou désactiver la trace des messages

Remarque

Si vous désactivez la trace des messages, les données de trace de l'instance serverless ne peuvent pas être stockées ni interrogées, et l'option de requête de trace des messages n'apparaîtra pas dans la console.
Si vous activez la trace des messages, vous serez facturé pour les traces de messages générées par l'instance serverless. Pour plus d'informations, consultez Frais de trace des messages.

Connectez-vous à la console ApsaraMQ for RocketMQ. Dans le volet de navigation de gauche, cliquez sur Instances.
Dans la barre de navigation supérieure, sélectionnez une région, par exemple China (Hangzhou). Sur la page Instances, cliquez sur le nom de l'instance que vous souhaitez gérer.
Sur la page Instance Details, cliquez sur l'onglet Basic Information. Ensuite, cliquez sur Enable ou Disable à côté du paramètre Message Trace.
Dans la boîte de dialogue qui s'affiche, cliquez sur OK.

Interroger les traces de messages

Connectez-vous à la console ApsaraMQ for RocketMQ. Dans le volet de navigation de gauche, cliquez sur Instances.
Dans la barre de navigation supérieure, sélectionnez une région, par exemple China (Hangzhou). Sur la page Instances, cliquez sur le nom de l'instance que vous souhaitez gérer.
Dans le volet de navigation de gauche, cliquez sur Message Traces. Sur la page Message Traces, sélectionnez une méthode de requête, saisissez les conditions, puis cliquez sur Query.

Les résultats s'affichent dans un tableau comprenant des colonnes telles que Message ID, Topic, Tag, Message Key et Creation Time. Dans la colonne Actions, cliquez sur Message Traces pour afficher les détails de la trace du message correspondant.
Recherchez le message cible dans les résultats de la requête et cliquez sur Message Trace dans la colonne Actions. Un panneau s'affiche, vous permettant de consulter les informations détaillées sur le message.

Le panneau de trace des messages affiche le cycle de vie complet du message, de la production à la consommation, divisé en trois zones : La zone Producer affiche la source du message, les informations sur le producteur, le nom d'hôte, l'heure d'envoi, l'heure d'arrivée sur le serveur et le résultat de l'envoi. La zone MQ Server affiche le type de message, l'ID du message, le topic, les clés de message et le tag. La zone Consumer affiche l'ID du groupe, les statistiques de consommation (tentatives totales et échouées) et l'état de consommation de chaque groupe de consommateurs.
Si le message a été consommé avec succès, cliquez sur l'ID du groupe sur la carte Consumer pour afficher les informations détaillées sur la consommation. Cliquez sur Export Image pour générer une image des détails actuels de la trace du message.

Les détails de la trace du message se composent de trois panneaux : Le panneau Producer affiche l'heure d'envoi, l'heure d'arrivée sur le serveur et le résultat de l'envoi. Le panneau MQ Server affiche le type de message, l'ID du message, le topic et le tag. Le panneau du groupe de consommateurs (par exemple, test_group1), une fois développé, affiche le nombre de livraisons, le résultat de la livraison, l'état de la livraison ordonnée, l'heure de livraison et l'heure de réponse.

Rubriques connexes

Vous pouvez également gérer les traces de messages en appelant les opérations d'API suivantes :