ConsumeMQTT 2025.5.31.15¶
Bundle¶
org.apache.nifi | nifi-mqtt-nar
Description¶
S’abonner à un sujet et recevoir des messages d’un broker MQTT
Exigences en matière d’entrées¶
FORBIDDEN
Prend en charge les propriétés dynamiques sensibles¶
false
Propriétés¶
Propriété |
Description |
|---|---|
Broker URI |
La ou les URI à utiliser pour se connecter au brocker MQTT (par exemple, tcp://localhost:1883). Les schémas « tcp », « ssl », « ws » et « wss » sont pris en charge. Pour que « ssl » puisse être utilisée, il faut que la propriété SSL Context Service soit définie. Lorsqu’une liste URI séparée par des virgules est spécifiée (par exemple, tcp://localhost:1883,tcp://localhost:1884), le processeur utilise un algorithme round-robin pour se connecter aux brokers en cas d’échec de la connexion. |
ID de client |
L’ID du client MQTT à utiliser. Si cette propriété n’est pas spécifiée, un UUID sera généré. |
Connection Timeout (seconds) |
Intervalle de temps maximum pendant lequel le client attendra l’établissement de la connexion réseau avec le serveur MQTT. Le délai d’expiration par défaut est de 30 secondes. La valeur 0 désactive le traitement du délai d’expiration, ce qui signifie que le client attendra jusqu’à ce que l’établissement de la connexion au réseau ait réussi ou échoué. |
ID de groupe |
ID du groupe de consommateurs MQTT à utiliser. Si aucun ID de groupe n’est spécifié, le client se connectera en tant que consommateur individuel. |
Keep Alive Interval (seconds) |
Définit l’intervalle de temps maximum entre les messages envoyés ou reçus. Il permet au client de détecter si le serveur n’est plus disponible sans avoir à attendre le délai d’expiration TCP/IP. Le client veille à ce qu’au moins un message traverse le réseau au cours de chaque intervalle de maintien en vie. En l’absence de message lié aux données pendant cette période, le client envoie un très petit message « ping », dont le serveur accuse réception. La valeur 0 désactive le traitement Keep Alive dans le client. |
Last Will Message |
Le message à envoyer en tant que dernière volonté du client. |
Last Will QoS Level |
Niveau de QoS à utiliser lors de la publication du message de dernières volontés. |
Last Will Retain |
Précise si les dernières volontés du client doivent être conservées ou non. |
Last Will Topic |
Le sujet auquel envoyer les dernières volontés du client. |
MQTT Specification Version |
La version de la spécification MQTT à utiliser lors de la connexion avec le broker. Voir la description des valeurs autorisées pour plus de détails. |
Max Queue Size |
Les messages MQTT sont toujours envoyés aux abonnés d’un sujet, quelle que soit la fréquence d’exécution planifiée pour le processeur. Si la planification d’exécution est nettement en retard par rapport à la vitesse à laquelle les messages arrivent à ce processeur, il peut se produire une accumulation dans la file d’attente interne de ce processeur. Cette propriété indique le nombre maximal de messages que ce processeur peut garder en mémoire en même temps dans la file d’attente interne. Ces données seraient perdues en cas de redémarrage de NiFi. |
Mot de passe |
Mot de passe à utiliser lors de la connexion au brocker |
Quality of Service (QoS) |
La qualité de service (QoS) avec laquelle le message doit être reçu. Accepte les valeurs 0, 1 ou 2 : 0 pour « au plus une fois », 1 pour « au moins une fois », et 2 pour « exactement une fois ». |
Service contextuel SSL |
Le service de contexte SSL utilisé pour fournir des informations sur les certificats des clients pour les connexions TLS/SSL. |
Session Expiry Interval |
À l’issue de cet intervalle, l’agent de change met fin à la relation avec le client et efface l’état de la session. |
État de la session |
Détermine s’il s’agit d’un nouveau flux ou de la reprise de flux antérieurs. Voir la description des valeurs autorisées pour plus de détails. |
Topic Filter |
Le filtre des sujets MQTT utilisé pour désigner les sujets auxquels s’abonner. |
NomUtilisateur |
Nom d’utilisateur à utiliser lors de la connexion au broker |
add-attributes-as-fields |
Si vous définissez cette propriété sur true, les champs par défaut suivants seront ajoutés à chaque enregistrement : _topic, _qos, _isDuplicate et _isRetained. |
message-demarcator |
Cette propriété vous permet de générer des FlowFiles contenant plusieurs messages. Elle vous permet de fournir une chaîne (interprétée comme de l’UTF-8) à utiliser pour délimiter plusieurs messages. Il s’agit d’une propriété facultative : si elle n’est pas fournie, et si aucun Record Reader/Writer n’est défini, chaque message reçu donnera lieu à un seul FlowFile. Pour saisir un caractère spécial tel que « nouvelle ligne », utilisez CTRL+Entrée ou Maj+Entrée en fonction de l’OS. |
record-reader |
Le Record Reader à utiliser pour analyser les messages MQTT reçus et les convertir en enregistrements. |
record-writer |
Le Record Writer à utiliser pour sérialiser les enregistrements avant de les écrire dans un FlowFile. |
Relations¶
Nom |
Description |
|---|---|
Message |
La sortie du message MQTT |
parse.failure |
Si un message ne peut pas être analysé par le Record Reader configuré, le contenu du message sera routé vers cette relation sous la forme d’un FlowFile individuel. |
Écrit les attributs¶
Nom |
Description |
|---|---|
record.count |
Le nombre d’enregistrements reçus |
mqtt.broker |
Le broker MQTT qui était à l’origine du message |
mqtt.topic |
Le thème MQTT sous lequel le message a été reçu |
mqtt.qos |
La qualité de service pour ce message. |
mqtt.isDuplicate |
Détermine si ce message peut être un doublon d’un message déjà reçu. |
mqtt.isRetained |
Indique si ce message provient d’un éditeur actuel ou s’il a été « retenu » par le serveur en tant que dernier message publié sur le sujet. |