Apache Kafka integration configuration fields

  • Release version: Washingtondc
  • Updated April 7, 2025
  • 3 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Apache Kafka Integration Configuration Fields

    This document outlines the configuration fields necessary for integrating Apache Kafka with Health Log Analytics in ServiceNow. Understanding these fields enables IT Operations Management to effectively manage log data from Kafka, ensuring streamlined data retrieval and analysis.

    Show full answer Show less

    Key Features

    • Integration Name: A unique identifier for the integration, which automatically updates on the form.
    • Execute on: Choose between a specific MID Server or a MID Server cluster for data processing.
    • MID Server Settings: Specify the MID Server to pull data, with options to modify the maximum data inputs.
    • Service Instance: Required field to define the service instance for log data binding.
    • Data Source: Identifies the log data source as Kafka, which is read-only.
    • Topics: Specify topics for data subscription, essential for data retrieval.
    • Advanced Settings: Options such as timeout settings, character encoding, and data sampling ratios to optimize data handling.

    Key Outcomes

    By properly configuring the Apache Kafka integration, ServiceNow customers can:

    • Efficiently ingest and manage log data from Kafka into ServiceNow.
    • Utilize failover MID Server clusters to enhance data reliability and processing continuity.
    • Employ advanced settings to fine-tune data retrieval and optimize performance based on their operational needs.

    Description of the fields on the Apache Kafka integration configuration forms for Health Log Analytics.

    Table 1. Provide details
    Field Description
    Integration Name Unique name of this integration. For example: My Kafka integration. This field is required.
    Note:
    When you fill in this field, the generic name displayed on the form adjusts automatically to match the name you entered.
    Execute on Option to determine whether to use a specific MID Server or a MID Server cluster.

    This feature is supported in the Health Log Analytics application, Version 26.0.17 - February 2023 and later, available from the ServiceNow Store.
    MID server name

    (Only when the Execute on field is set to Specific MID Server)

    MID Server to which log data from Apache Kafka is pulled. This field is required.
    Note:
    • You can select only MID Servers that support basic authentication. MID Servers that support mTLS are not listed.
    • The default maximum number of data inputs streaming logs to a single MID Server is 10. You can modify the maximum number by adding the property sn.occ.log_ingestion.max_datainputs_per_mid to the MID Server and then changing the default value.
    • If log ingestion is not enabled for the selected MID Server, Health Log Analytics enables it automatically.
    MID Server Cluster

    (Only when the Execute on field is set to Specific MID Server Cluster)

    The MID Server cluster to which the log data is pulled.

    The data input runs on a single MID Server in the cluster until that MID Server fails. The system then moves all the data input tasks to the next available MID Server in the cluster according to the configured order.

    This feature is supported in the Health Log Analytics application, Version 26.0.17 - February 2023 and later, available from the ServiceNow Store.

    Note:
    • Health Log Analytics supports only failover MID Server clusters. In these clusters, multiple MID Servers are grouped together for failover protection. When selecting a cluster from the data input form, the MID Server Clusters list displays only failover clusters.
    • The MID Server cluster must include only MID Servers that support basic authentication. mTLS is not supported for log ingestion.
    • Log ingestion must be enabled for each MID Server in the cluster. If log ingestion is not enabled for the active MID Server, Health Log Analytics enables it automatically.
    • The default maximum number of data inputs streaming logs to a single MID Server is 10. A cluster passes capacity validation if it contains at least one MID Server with fewer than 10 data inputs running on it, even when that MID Server is down.
    For more information about MID Server clusters, see Configure a MID Server cluster.

    This field is required.
    Service instance The service instance (formerly the application service) to which to bind the log data. This field is required.
    Data source The source of the log data that the integration pulls to your ServiceNow instance: Kafka. This field is read-only.
    Description Option to add a brief description of the integration to help identify it.
    Table 2. Set data retrieval method
    Field Description
    Kafka node names A comma-separated list in the format HOST:PORT,HOST:PORT. This field is required.

    The list does not have to include all the Apache Kafka Cluster servers.
    Topics A comma-separated list of topics to which the data input must subscribe. This field is required.
    Kafka credentials The Apache Kafka credentials.

    You can select existing Kafka SSL credentials, or create new ones by selecting Create Kafka credentials from the drop-down list. For a description of the fields on the Kafka SSL credentials form, see Kafka SSL credentials fields.
    Group ID The name of the Apache Kafka Consumer Group.
    Table 3. Advanced settings
    Field Description Default value
    Timeout The time, in milliseconds, spent waiting in the poll if data is not available in the topics. 500
    Default timezone The time zone of events that the system will use if a log does not specify the time zone.

    By default, the system uses GMT in such cases, but you can specify a different time zone.

    		 GMT
    Sub sample receive ratio The number of events to batch together, out of which all but one will be discarded. This setting is used to decrease the number of received events. -1
    Character encoding The character encoding for this data input. This field is read-only. UTF-8
    Node discovery timeout The time, in milliseconds, before node discovery times out. 30
    Sub sample drop ratio The number of events to batch together, out of which one will be discarded. This setting is used to reduce the number of fetched events. -1
    Max length in bytes The maximum length, in bytes, of events. 32766
    Drop if queue is full Option for selecting to discard logs if there is a load on the MID Server. False