Apache Kafka integration configuration fields

  • Release version: Australia
  • Updated March 12, 2026
  • 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 for setting up the Apache Kafka integration with Health Log Analytics in ServiceNow. Proper configuration is essential to ensure effective log data ingestion from Apache Kafka.

    Show full answer Show less

    Key Features

    • Integration Name: Assign a unique name to the integration. This is a required field.
    • Execute On: Choose between a specific MID Server or a MID Server cluster for log ingestion. This field is mandatory.
    • MID Server Name: Specify the MID Server for log data retrieval when using a specific MID Server. Only those supporting basic authentication are eligible.
    • MID Server Cluster: If selected, log data will be pulled from a designated MID Server cluster, which must consist of failover-enabled MID Servers.
    • Service Instance: Bind the log data to the appropriate service instance, a required field.
    • Data Source: The source of log data, set to Kafka and read-only.
    • Kafka Node Names: Input a comma-separated list of Kafka node addresses, required for connection.
    • Topics: Provide a comma-separated list of topics for data input subscription, also required.
    • Kafka Credentials: Specify the credentials for accessing Kafka, with options to use existing or create new ones.
    • Group ID: Define the name of the Apache Kafka Consumer Group.

    Advanced Settings

    • Timeout: Default is 500 ms for waiting in the poll for data.
    • Default Timezone: Set the timezone for log events, defaulting to GMT.
    • Subsample Receive Ratio: Adjust the number of events batched together; default is -1 (no batching).
    • Character Encoding: Set to UTF-8, read-only.
    • Node Discovery Timeout: Set to 30 ms before timeout occurs.
    • Subsample Drop Ratio: Number of events batched with one discarded; default is -1.
    • Max Length in Bytes: Set to a maximum of 32766 bytes for event lengths.
    • Drop if Queue is Full: Default is set to false, meaning logs will not be discarded under load.

    Key Outcomes

    By accurately configuring these fields, ServiceNow customers can ensure seamless integration with Apache Kafka for effective log data management, leading to improved analytics and operational efficiency.

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

    For the Apache Kafka integration setup procedure, see Set up an Apache Kafka integration 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 select whether to use a specific MID Server or a MID Server cluster. This field is required.
    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 Execute on is set to Specific MID Server cluster.)

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

    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.

    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 or integration 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 or integrations 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 or integrations running on it, even when that MID Server is down.
    For more information about MID Server clusters, see Configure a MID Server cluster.
    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 to discard logs if there is a load on the MID Server. False