Skip to content
Data input configuration fields › Health Log Analytics reference › Health Log Analytics › ITOM AIOps › IT Operations Management
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

Apache Kafka data input configuration fields

Description of the fields on the Apache Kafka data input configuration form.

Basic configuration

FieldDescription
NameName of the new data input. This field is required.
DescriptionDescription of the data input.
Execute onOption to select whether to use a specific MID Server or a MID Server cluster. This field is required.
MID

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

MID Server to which log data from Apache Kafka is pulled. 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 this number in the MID Server properties.
  • If log ingestion is not enabled for the selected MID Server, Health Log Analytics enables it automatically.

This field is required.

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 to which to bind the log data. Note: If no relevant service instance exists, Create an service instance and add CIs to it. Set the status of the new service instance to Operational.

This field is required.

The following fields show read-only information:

FieldDescription
StatusStatus of the data input.
TransportProtocol used to stream the log data.This data input uses Apache Kafka to stream log data to your instance.
Sources countThe number of log sources this data input has created.
Disabled sinceThe time when the data input stopped or failed.
Last log timeThe time when the last log streamed in the data input.
Error messageThe streaming error.This field is populated automatically. It displays only when a streaming error has occurred.
FieldDescriptionExample
From

Starting date and time for reading the data. Data older than this date and time is not read.Note: Setting this value to a past date might require the system to read large amounts of data, causing congestion.

This field is required.

Now -1 week
FieldDescriptionExample
Kafka node namesA comma-separated list in the format HOST:PORT,HOST:PORT. The list does not have to include all the Apache Kafka Cluster servers.123.4.5.6:9092,123.3.4.5:9093
TopicsA comma-separated list of topics to which the data input must subscribe.This field is required.FirstTopic,SecondTopic,ThirdTopic
Kafka credentials

Reference to the Apache Kafka credentials.You can display the Kafka SSL credentials form by selecting the Search icon (

Image omitted: List_SearchIcon.png
No alternative text supplied
) and opening a record. The form enables you to choose the security protocol used for authenticating with Apache Kafka from the following options:
  • SSL - SSL channel.
  • SASL_SSL - SASL authenticated, SSL channel.
  • SASL_PLAINTEXT - SASL authenticated, non-encrypted channel.

For a description of the fields on the Kafka SSL credentials form, see Kafka SSL credentials fields.

None
Group IdThe name of the Apache Kafka Consumer Group.logs

Advanced configuration

FieldDescriptionDefault value
TimeoutThe time, in milliseconds, spent waiting in the poll if data is not available in the topics.500
Node discovery timeoutThe time, in milliseconds, before node discovery times out.30
Default timezoneThe default timezone if the log doesn't include timezone information.GMT
Sub sample drop ratioThe 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
Sub sample receive ratioThe 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
Max length in bytesThe maximum length, in bytes, of events.32766
Character encodingThe character encoding for this data input.UTF-8
Drop if queue is fullOption to discard logs if there is a load on the MID Server.False

Parent Topic:Data input configuration fields