Microsoft Azure Event Hubs integration configuration fields

  • Release version: Zurich
  • Updated July 31, 2025
  • 4 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 Microsoft Azure Event Hubs Integration Configuration Fields

    The Microsoft Azure Event Hubs integration configuration facilitates the setup for Health Log Analytics in ServiceNow. This integration allows users to pull log data from Event Hubs into their ServiceNow instance, enhancing data analytics and monitoring capabilities.

    Show full answer Show less

    Key Features

    • Integration Name: A unique identifier for the integration, essential for setup.
    • Service Instance: Specifies the service instance for log data binding.
    • Source: Indicates the log data source (PubSub), which is read-only.
    • Description: Option to provide a brief description of the integration for easier identification.
    • Execute On: Choose between a specific MID Server or a MID Server cluster for processing logs.
    • MID Server Settings: Configuration options for log ingestion capabilities, including support for basic authentication.
    • Event Hubs Namespace and Name: Required fields to specify the Event Hub from which logs are fetched.
    • Consumer Group: Specifies or creates a Consumer Group for log retrieval.
    • Event Hub Credentials: Required credentials for accessing the Event Hub.
    • Advanced Settings: Options to configure log processing parameters such as restore point rate, subsampling ratios, timeouts, and character encoding.

    Key Outcomes

    By configuring the Microsoft Azure Event Hubs integration, customers can efficiently stream log data into ServiceNow, allowing for enhanced monitoring and analytics. Key benefits include:

    • Improved data retrieval capabilities through specified Event Hubs and Consumer Groups.
    • Flexible log processing with adjustable parameters to optimize performance and reduce load.
    • Automatic handling of log ingestion settings on MID Servers to ensure seamless data flow.

    Description of the fields on the Microsoft Azure Event Hubs integration configuration forms for Health Log Analytics.

    For the Microsoft Azure Event Hubs integration setup procedure, see Set up a Microsoft Azure Event Hubs integration for Health Log Analytics.

    Table 1. Provide details
    Field Description
    Integration Name Unique name of this integration. For example: My Event Hubs 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.
    Service Instance The service instance (formerly the application service) to which to bind the log data. This field is required.
    Source The source of the log data that the integration pulls to your ServiceNow instance: PubSub. This field is read-only.
    Description Option to add a brief description of the integration to help identify it.
    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 Execute on is set to Specific MID Server.)

    The MID Server to which the logs are streamed.
    Note:
    • You can only select a MID Server with log ingestion capability that supports basic authentication. MID Servers that support mTLS are not listed.
    • If log ingestion is not enabled on the selected MID Server, Health Log Analytics enables it automatically.
    • 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.
    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.
    Table 2. Set data retrieval method
    Event Hubs namespace The scoping container for the event hub or hubs. This field is required.
    Event Hub name The event hub from which to fetch log data. This field is required.
    Consumer Group name The Consumer Group to use. This field is required.

    Enter an existing Consumer group or create one in the event hub. The default value is $Default.
    Event Hub Credentials The Event Hub credentials to use. This field is required.

    Select existing Azure Shared Access Signature (SAS) credentials or create the Azure SAS credentials to use. If you create new Azure SAS credentials, you must provide the SAS policy name and key.
    Table 3. Advanced settings
    Field Description
    Restore point rate The number of logs the integration can read before a restore point is saved.
    Processor threads count The total number of processor threads.
    Sub sample drop ratio The ratio of logs to discard.

    This setting determines the number of logs to group together, out of which one is dropped. It reduces the number of fetched logs.

    The default value is -1: no logs are discarded. For example, if you want one log out of every five to be dropped, change the value to 5.
    Sub sample receive ratio The ratio of logs to receive.

    This setting determines the number of logs to group together, out of which one is received. It reduces the number of logs you receive.

    The default value is -1, meaning no logs are received. For example, if you want to receive one log out of every five, change the value to 5.
    Operation timeout (seconds) The number of seconds to wait before timing out event hubs operations.
    Receive idle timeout (seconds) The number of seconds to wait before timing out receive operations.
    Max length in bytes The maximum length, in bytes, of log messages. The default value is 32766.
    Prefetch count The number of logs received in advance of event hubs operations.
    Max batch size The maximum number of events passed to a single process call. The default value is 100.
    Default timezone The default time zone of logs. The system uses this default when the log does not specify a time zone. The default value is GMT.
    Character encoding The character encoding for this integration. The default value is UTF-8.
    Drop if queue is full Option to select discarding logs if there is a load on the MID Server.