Set up an Apache Kafka integration for Health Log Analytics

  • Rversion finale: Australia
  • Mis à jour 12 mars 2026
  • 4 minutes de lecture

    • Set up an integration for streaming log data from Apache Kafka to your ServiceNow instance for processing by Health Log Analytics.

    Avant de commencer

    • Verify that a MID Server is installed and configured with the Log Ingestion capability enabled. For more information, see MID Server system requirements.
      Important :
      Health Log Analytics does not support IPv6. To work with the application, configure the MID Server to IPv4.
    • Unless the MID Server and external clients are on the same network, the MID Server must have a public IP address. This is required when its IP is exposed through network address translation (NAT), a load balancer, or a similar device. The public IP address enables external clients, such as Filebeat agents located outside its network, to reach the MID Server. Private IP addresses are not routable over the internet. Without a public IP, external clients cannot connect to the MID Server even if they are configured with its address. In the MID Server properties, add a property named mid.public_ip with the public IP address as the value. For more information, see Create a MID Server property. If the MID Server and external clients are on the same network, connections can be made using the private IP address.
    • Consider whether to pull the log data to a single MID Server or to a MID Server cluster.

      In MID Server clusters, multiple MID Servers are grouped together for failover protection. The active integration runs on a single MID Server in the cluster. If that MID Server fails, the system moves its tasks to the next available MID Server in the cluster in a configured order.

      If you decide to use a MID Server cluster, verify the following:

      • The MID Server cluster includes only MID Servers that support basic authentication.
        Remarque :
        mTLS is not supported for log ingestion.
      • Log ingestion is enabled for each MID Server in the cluster.
        Remarque :
        If log ingestion is not enabled for the active MID Server, Health Log Analytics enables it automatically.
      • No more than the default maximum of 10 integrations will pull logs to a single MID Server.

        A cluster passes capacity validation if it contains at least one MID Server with fewer than 10 integrations running on it, even when that MID Server is down.

    Role required: evt_mgmt_admin

    Pourquoi et quand exécuter cette tâche

    You set up integrations through the Integrations Launchpad in Service Operations Workspace, which you access from the ITOM AIOps configuration center. The AIOps configuration center is a centralized workspace for configuring and managing AIOps features from a single place. The integrations setup process reduces implementation time compared to manual data input setup in the classic interface in Health Log Analytics. For more information, see Integrations Launchpad in Service Operations Workspace for ITOM.

    Procédure

    1. Navigate to Workspaces > Service Operations Workspace.
    2. From the bottom of the navigation pane, select the AIOps configuration center icon ITOM AIOps configuration center icon.
      The ITOM AIOps configuration center page appears. The configuration center is a centralized workspace. Use it to configure and manage AIOps features from a single place.
    3. From the Integrate section, under Integrations, select Add integration.
      The Integrations Launchpad appears.
    4. In the Browse integrations tab, search for Kafka.
    5. Select the Kafka integration tile.
      Remarque :
      If you start an integration setup before meeting all prerequisites, a message appears. You can cancel the setup and complete the prior requirements first. Alternatively, you can continue in draft mode and complete the requirements later. Note that you can't activate the integration until you have completed all the prerequisites.
    6. On the Provide details form, fill in the fields.
      For a description of the fields, see the Provide details table in Apache Kafka integration configuration fields.
    7. Select Next.
    8. On the Set data retrieval method form, fill in the fields.
      For a description of the fields, see the Set data retrieval method table in Apache Kafka integration configuration fields.
    9. Facultatif : Select Advanced settings and fill in the advanced configuration fields.
      For a description of the fields, see the Advanced settings table in Apache Kafka integration configuration fields.
    10. Facultatif : Select Test and save to save the integration to the database and test connectivity.
    11. Do one of the following:
      • If you completed all the prerequisites before starting the configuration, select Activate.

        In the pop-up window, select Test & Save to save the integration to the database and test connectivity. If an error is returned, adjust the configuration as suggested in the error message and then try to activate the integration again.

        When the test is successful, the integration is activated and the Overview tab is displayed. On the Integrations Launchpad, the integration tile is available in the Installed integrations tab.

      • If you didn't complete all the prior requirements, select Save draft.

        The system saves the integration as a draft in the Integrations Launchpad. It appears in the Installed integrations tab, under Waiting for your action. You can complete the prerequisites and activate the integration later. For more information, see Activate a draft integration in Health Log Analytics.

    Que faire ensuite

    On the Overview tab, do the following: