Configurer le Apache Kafka connecteur de consommateur

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 5 minutes de lecture
  • Configurez l’instance Apache Kafka du connecteur de consommateur pour créer des événements à partir de messages collectés par le Apache Kafka connecteur.

    Avant de commencer

    Assurez-vous que le module d’extension Gestion des événements Connecteurs (sn_em_connector) est installé sur l’instance Now Platform .

    Rôle requis : evt_mgmt_admin

    Procédure

    1. Accédez à la Tous > Gestion des événements > Intégrations > Instances des connecteurs.
    2. Sélectionnez Nouveau.
    3. Renseignez les champs du formulaire.
      Tableau 1. Formulaire Instance de connecteur
      Champ Valeur
      Nom Nom descriptif et unique pour le connecteur de consommateur Kafka.
      Description Description à utiliser par l’instance de collecte d’événements de consommateur Kafka.
      Définition de connecteur Nom de la définition de connecteur requise, dans ce cas, doit être Consommateur Kafka.
      IP de l'hôte L’adresse IP de l’hôte.
      Remarque :
      Ce champ doit contenir une valeur pour terminer le processus de création, de sorte que l’espace réservé 1.1.1.1 doit être saisi en tant que valeur temporaire.
      Heure de la dernière exécution de la collecte d'événements Ce champ est automatiquement défini sur la dernière valeur d’exécution.
      État de la dernière collecte d'événements Ce champ est automatiquement défini sur le dernier état d’exécution.
      Calendrier de collecte d'événements (secondes) Fréquence, en secondes, à laquelle le système recherche de nouveaux événements à partir du consommateur Kafka. La valeur par défaut est de 60 secondes.
      Dernier message d'erreur Ce champ est automatiquement défini sur le dernier message d’erreur.
    4. Pour PLAINTEXT ou SASL_PLAINTEXT, dans le champ Informations d’identification , créez des informations d’identification d’authentification de base.
      Utilisez le type d’informations d’identification Kafka SSL pour une nouvelle instance de connecteur pull Kafka avec authentification SASL_PLAINTEXT . Passez à l’étape 5.

      Utilisez le type d’informations d’identification Kafka SSL lorsque la valeur du paramètre sasl.enabled.mechanisms ou sasl.mechanism du serveur Kafka n’est pas égale à PLAIN. Passez à l’étape 5.

      1. Sélectionnez l’icône de recherche en regard du champ Informations d’identification .
      2. Sur l’écran Informations d’identification, sélectionnez Nouveau.
      3. Dans la liste des informations d’identification disponibles, sélectionnez Informations d’identification pour l’authentification de base.
      4. Sur l’écran Authentification de base, fournissez des informations pour l’authentification en TEXTE BRUT, qui ne nécessite pas d’informations d’identification, ou pour l’authentification SASL_PLAINTEXT, qui nécessite des informations d’identification.
        • Pour une authentification en TEXTE BRUT, dans le champ Nom , saisissez n’importe quelle valeur et laissez les champs Nom d’utilisateur et Mot de passe vides.
        • Pour SASL_PLAINTEXT authentification, donnez un nom aux informations d’identification dans le champ Nom, de préférence précédé de SASL. Fournissez le nom d’utilisateur et le mot de passe dans les champs Nom d’utilisateur et Mot de passe .
      5. Sélectionnez Envoyer.
    5. Pour des informations d’identification d’authentification SASL_PLAINTEXT, SSL ou SASL_SSL, dans le champ Informations d’identification , créez des informations d’identification Kafka SSL.
      1. Sélectionnez l’icône de recherche en regard du champ Informations d’identification .
      2. Sur l’écran Informations d’identification, sélectionnez Nouveau.
      3. Dans la liste des informations d’identification disponibles, sélectionnez Informations d’identification Kafka SSL.
      4. Sur l’écran Authentification Kafka SSL, renseignez les champs Informations d’identification Kafka SSL.
        Pour obtenir la description des champs Informations d’identification Kafka SSL, reportez-vous à la section .
        Remarque :
        Si vous désactivez le champ Désactiver la vérification du nom d’hôte, saisissez la valeur du ssl.endpoint.identification.algorithm paramètre dans le champ Propriétés de consommateur Kafka supplémentaires, à savoir celle du paramètre de serveur Kafka. Par exemple :
        ssl.enabled.protocols=TLSv1.2,TLSv1.1,TLSv1;
        sasl.jaas.config=org.apache.kafka.common.security.plain.PlainLoginModule required username=<username> password=<password>;
        sasl.enabled.mechanisms=PLAIN;ssl.endpoint.identification.algorithm=;
      5. Sélectionnez Envoyer.
    6. Cliquez avec le bouton droit sur l'en-tête du formulaire, puis sélectionnez Enregistrer.
    7. Dans la table présentant les valeurs de l’instance de connecteur, vérifiez les valeurs de l’instance de connecteur renseignées en fonction de votre configuration Kafka et du message (charge utile JSON) que vous avez reçu de la rubrique Kafka.

      Modifiez les valeurs d’instance du connecteur si nécessaire.

      Tableau 2. Table Valeurs de l’instance de connecteur
      Champ Description
      authentication_type

      Type d’authentification de consommateur Kafka. Les valeurs actuellement prises en charge sont les suivantes :

      • PLAINTEXT (aucune authentification) (par défaut)

      • SASL_PLAINTEXT (authentification de base – nom d’utilisateur et mot de passe)

      bootstrap_servers

      Les serveurs qui établissent la connexion avec la grappe Kafka. Les valeurs de ce champ doivent être de la forme host1 :port1, host2 :port2, etc. (séparées par des virgules).

      Ce champ est obligatoire.

      consumer_group_name

      Nom du groupe de consommateurs.

      Si la même rubrique Kafka est utilisée à partir de deux instances différentes, utilisez des noms de groupes de consommateurs différents afin que tous les événements soient capturés pour les deux instances.

      Ce champ est obligatoire.

      time_of_event_field

      Nom du champ dans la charge utile/le message JSON qui inclut l’heure de l’événement.

      Si un champ de la charge utile/du message JSON inclut l’heure de l’événement, cette valeur doit être la valeur de ce paramètre.

      Si aucune valeur de champ temporel n’est fournie, l’heure de réception de l’événement dans l’instance ServiceNow est définie comme time_of_event.

      Le champ time_of_event doit être un champ de premier niveau dans la charge utile/le message JSON. Les noms de champs imbriqués ne sont pas autorisés.

      fuseau horaire

      Fuseau horaire du champ time_of_event dans la charge utile/le message JSON.

      La valeur de fuseau horaire n’est pas utilisée lorsque le champ time_of_event est vide.

      Par exemple, si la time_of_event de la charge utile/du message se trouve dans le fuseau horaire IST, la valeur est GMT+0530.

      Valeur par défaut : GMT.

      date_format

      Le format date_time du champ time_of_event dans la charge utile/le message JSON.

      Si aucune valeur de champ horaire n’est fournie, l’heure à laquelle l’événement a été reçu dans l’instance en heure GMT est utilisée. La valeur date_time n’est pas utilisée lorsque le champ time_of_event est vide.

      Valeur par défaut : aaaa-MM-jj HH:mm:sss.

      debug Option permettant d’afficher les journaux de débogage. Valeur par défaut : false
      logPayloadForDebug Option permettant d’afficher les journaux liés à la charge utile JSON. Valeur par défaut : false
      sujet

      Rubrique Kafka à partir de laquelle les messages sont extraits.

      Ce champ est obligatoire.

    8. Dans la section MID Servers pour les connecteurs , spécifiez un Serveur MID MID Server valide.
      Remarque :
      Vous pouvez configurer plusieurs Serveurs MID. Si le premier serveur est en panne, le suivant Serveur MID est utilisé. Si ce Serveur MID n’est pas disponible, le suivant est sélectionné, et ainsi de suite. Serveurs MID sont triés en fonction de l’ordre dans lequel leurs détails ont été saisis dans la section MID Servers pour les connecteurs .

      Si vous ne spécifiez pas un Serveur MID, un disponible Serveur MID avec une plage d’adresses IP correspondante est utilisé.

    9. Cliquez avec le bouton droit sur l'en-tête du formulaire, puis sélectionnez Enregistrer.
    10. Testez la connexion entre le Serveur MID et le connecteur de consommateur Kafka.
      1. Sélectionnez Tester le connecteur.
      2. Si la connexion au test échoue, vérifiez si les informations d’identification sont valides et que le réseau est connecté de A Serveur MID au broker Kafka.
        Remarque :
        La validation du nom de rubrique Kafka se produit uniquement dans la validation du connecteur de test .
    11. Si le test a fonctionné, activez l’instance de connecteur en cochant la case Active .
    12. Sélectionnez le bouton Mettre à jour .

    Que faire ensuite

    Une fois le connecteur créé, vous devez mapper les champs. Pour plus d'informations, consultez Mapper les attributs de charge utile du message Kafka aux champs d’alerte.