Accesses the Azure Event Hubs to send, receive, or checkpoint messages.
Typical Uses
- Receive and send messages from an event hub
- Interoperability with Big Data analytics platforms
How does it work?
The AzureEventHubsConnector connects to Azure’s Event Hubs through the Kafka protocol using the Azure Event Hub SDK. Supports publishing, receiving messages, and checkpointing messages. A message is also known in the Azure documentation as an event.
Configuration
Input Ports
Input
This transformer accepts any feature.
Output Ports
Output
The output of this transformer will vary depending on the action performed. Message data and metadata are presented as feature attributes.
- After a Receive action, output features represent messages received from Azure Event Hub.
- After a Send action, output features represent messages sent to Azure Event Hub.
Initiator
The incoming feature is output through this port.
<Rejected>
Features that cause the operation to fail are output through this port. An fme_rejection_code attribute, having the value ERROR_DURING_PROCESSING, will be added, along with a more descriptive fme_rejection_message attribute which contains more specific details as to the reason for the failure.
Note: If a feature comes in to the AzureEventHubsConnector already having a value for fme_rejection_code, this value will be removed.
Gestion des entités rejetées : ce paramètre permet d'interrompre la traduction ou de la poursuivre lorsqu'elle rencontre une entité rejetée. Ce paramètre est disponible à la fois comme option par défaut de FME et comme paramètre de traitement.
Parameters
Authentication
| Credential Source |
Required for authentication. Using a web connection integrates best with FME, but in some cases, you may wish to use one of the other sources.
|
| Account |
Available when the credential source is Web Connection. To create an Azure Event Hubs connection, click the 'Account' drop-down box and select 'Add Web Connection...'. The connection can then be managed via Tools -> FME Options... -> Web Connections. |
Embedded Credentials
| Event Hub Connection String | Available when the Credential Source is Embedded. The connection string is found in the Azure Portal Event Hubs Namespace under Shared Access Policies. |
Request
| Action |
The type of operation to perform. Choices are:
|
|
Event Hubs |
The event hub to connect to. |
Some parameters are variable, depending on the value of the Request > Action parameter.
Parameters - Send Action
Send Options
|
Payload |
The content of the message. This is often JSON, but can be any string, binary, integer or floating-point value. |
||||
|
Partition ID |
(Optional) The specific partition ID to send to. If empty, a message will be assigned to a random partition using round-robin. |
||||
|
Message Properties |
(Optional) Additional properties to send with each message.
|
Parameters - Receive Action
Receives messages from the front of the queue.
Checkpointing is also enabled, but optional.
Receive Options
|
Consumer Group |
The name of the consumer group to view the event hub stream. Consumer groups are created in the Azure portal. The default is ‘$Default’. |
|
Receive Mode |
Two message receiving options are available:
|
|
Batch Size |
In Batch mode, specifies the number of messages to read per batch. |
|
Partition ID |
(Optional) If specified, the client will receive from this partition only. If empty, the client will receive from all partitions. It is recommended that there is only one active receiver on a partition per consumer group. |
|
Prefetch Count |
(Optional) The number of messages to prefetch from Azure. Default is 300. |
| Starting Position |
(Optional) Start receiving from this event position if there is no checkpoint data for the partition. Checkpoint data will be used if available. Default (empty) is @latest which receives only new events. -1 starts receiving at the beginning of the stream Can be a string, integer or a datetime. |
| Starting Position Mode |
Determines whether the starting position is inclusive or not. Default is exclusive. |
Checkpoint Store (Azure Blob) - Optional
See Parameters - Checkpoint Action for more details.
|
Container Name |
The container name for the blob store. |
|
Connection String |
A connection string to an Azure Storage account. |
|
Checkpoint Interval |
(Optional) Submits a checkpoint store to Azure blob every nth message. The default checkpoints only at the end of the stream. There will always be a checkpoint at the end of a message stream. |
Parameters - Checkpoint Action
The checkpoint action manually checkpoints a message using the Azure Blob checkpoint store.
This option is used if there is post-processing of a message in a workspace in which you want the checkpoint to happen later after the message is received.
Checkpoint Options
|
Received Message ID |
The _receive_id attribute from a receiving transformer (with the Receive action) used to identify a message to checkpoint. |
Checkpoint Store (Azure blob)
Checkpoint store is optional for the Receive action and required for the Checkpoint action. It is used to store the partition load-balancing and checkpoint data when receiving events. Load balancing does not apply when receiving from a single partition.
If a checkpoint store is not provided, the checkpoint will be maintained internally in memory, and the client will receive events without load-balancing.
When used, a checkpoint store uses an Azure storage container to store offset information. The offset information is used to start receiving at the same position at the next receive.
|
Container Name |
The container name for the blob store. |
|
Connection String |
A connection string to an Azure Storage account. |
|
Checkpoint Interval |
(Optional) Submits a checkpoint store to Azure blob every nth message. The default checkpoints only at the end of the stream. There will always be a checkpoint at the end of a message stream. |
Output Attributes
The following attributes can be selected for inclusion on the output features. Each output feature represents a message that was either sent or received.
| _payload | The message payload. UTF-8 string if possible to decode, otherwise binary or numeric. |
| _enqueued_time | The timestamp when the message was sent. |
| _offset | The offset of the message. |
| _partition_key | The partition of the message. |
| _properties | A key, value pair of message properties. |
| _receive_id | An id generated to identify the message used for the Checkpoint action. |
| _sequence_number | The sequence number of the message. |
| _system_properties | Metadata set by the Event Hubs Service associated with the message. |
Éditer les paramètres des Transformers
À l'aide d'un ensemble d'options de menu, les paramètres du Transformer peuvent être attribués en faisant référence à d'autres éléments du traitement. Des fonctions plus avancées, telles qu'un éditeur avancé et un éditeur arithmétique, sont également disponibles dans certains Transformers. Pour accéder à un menu de ces options, cliquez sur 
à côté du paramètre applicable. Pour plus d'informations, voir Options de menus et paramètres de Transformer.
Définir les valeurs
Il existe plusieurs façons de définir une valeur à utiliser dans un Transformer. La plus simple est de simplement taper une valeur ou une chaîne de caractères, qui peut inclure des fonctions de différents types comme des références d'attributs, des fonctions mathématiques et de chaînes de caractères, et des paramètres d'espace de travail. Il existe un certain nombre d'outils et de raccourcis qui peuvent aider à construire des valeurs, généralement disponibles dans le menu contextuel déroulant adjacent au champ de valeur.
Définir des valeurs de paramètres
Utilisation de l'éditeur de texte
L'éditeur de texte fournit un moyen efficace de construire des chaînes de textes (dont les expressions régulières) à partir de données source diverses, telles que des attributs, des paramètres et des constantes, et le résultat est directement utilisé dans le paramètre.
Utilisation de l'éditeur arithmétique
L'éditeur arithmétique fournit un moyen simple de construire des expressions mathématiques à partir de plusieurs données source, telles que des attributs et des fonctions, et le résultat est directement utilisé dans un paramètre.
Valeur conditionnelle
Définit des valeurs selon un ou plusieurs tests.
Fenêtre de définition de conditions
Contenu
Les expressions et chaînes de caractères peuvent inclure des fonctions, caractères, paramètres et plus.
Lors du paramétrage des valeurs - qu'elles soient entrées directement dans un paramètre ou construites en utilisant l'un des éditeurs - les chaînes de caractères et les expressions contenant des fonctions Chaîne de caractères, Math, Date et heure ou Entité FME auront ces fonctions évaluées. Par conséquent, les noms de ces fonctions (sous la forme @<nom_de_fonction>) ne doivent pas être utilisés comme valeurs littérales de chaîne de caractères.
Types de contenu
| Ces fonctions manipulent les chaînes de caractères. | |
|
Caractères spéciaux |
Un ensemble de caractères de contrôle est disponible dans l'éditeur de texte. |
| Plusieurs fonctions sont disponibles dans les deux éditeurs. | |
| Fonctions Date/heure | Les fonctions de dates et heures sont disponibles dans l'Editeur texte. |
| Ces opérateur sont disponibles dans l'éditeur arithmétique. | |
| Elles retournent des valeurs spécifiques aux entités. | |
| Les paramètres FME et spécifiques au projet peuvent être utilisés. | |
| Créer et modifier un paramètre publié | Créer ses propres paramètres éditables. |
Options - Tables
Les Transformers avec des paramètres de style table possèdent des outils additionnels pour remplir et manipuler des valeurs.
Outils de tableau
|
Réordonner
|
Activé une fois que vous avez cliqué sur un élément de ligne. Les choix comprennent :
|
|
Couper, Copier et Coller
|
Activé une fois que vous avez cliqué sur un élément de ligne. Les choix comprennent :
Copier, copier et coller peuvent être utilisés au sein d'un Transformer ou entre Transfromers. |
|
Filtre
|
Commencez à taper une chaîne de caractères, et la matrice n'affichera que les lignes correspondant à ces caractères. Recherche dans toutes les colonnes. Cela n'affecte que l'affichage des attributs dans le Transformer - cela ne change pas les attributs qui sont sortis. |
|
Importer
|
Le bouton d'import remplit la table avec un jeu de nouveaux attributs lus depuis un jeu de données. L'application spécifique varie selon les Transformers. |
|
Réinitialiser/Rafraîchir
|
Réinitialise la table à son état initial, et peut fournir des options additionnelles pour supprimer des entrées invalides. Le comportement varie d'un Transformer à l'autre. |
Note : Tous les outils ne sont pas disponibles dans tous les Transformers.
Reference
|
Processing Behavior |
|
|
Feature Holding |
No |
| Dependencies | Microsoft Azure Account with the Event Hubs Service |
| Aliases | |
| History |
FME Community
FME Community iest l'endroit où trouver des démos, des tutoriaux, des articles, des FAQ et bien plus encore. Obtenez des réponses à vos questions, apprenez des autres utilisateurs et suggérez, votez et commentez de nouvelles entités.
Search for all results about the AzureEventHubsConnector on the FME Community.
Les exemples peuvent contenir des informations sous licence Open Government - Vancouver et/ou Open Government - Canada.