Configure the Kafka metrics connector instance

  • Release version: Zurich
  • Updated June 16, 2026
  • 1 minute to read

    • Configure the Kafka metric consumer connector instance to read message send to Kafka server over topic.

    Before you begin

    To activate metric collection, ensure that the MID Server that retrieves metrics is configured with the Metric Intelligence extension and that the extension is in Started mode. See Manually configure the Metric Intelligence extension.

    OAuth authentication for the Kafka Metrics Connector is supported only in the Australia release and later. Ensure your instance is upgraded to Australia or a newer version before configuring OAuth.

    • Create Kafka SSL credentials on ServiceNow instance. For more information, see Kafka SSL credentials fields.
    • ServiceNow does not support discovery for Kafka. Therefore, create the CI entry manually in the respective table.

    Role required: evt_mgmt_admin

    Procedure

    1. Navigate to Event Management > Integrations > Connector Instances.
    2. Select New and create a connector instance.
      For details on the connector instance fields displayed on the page, see Kafka connector instance form.
    3. In the MID Servers for connectors section,specify a MID Server that is up and is valid.
    4. Right-click the form header and select Save.
    5. In the table presenting the connector instance values, verify the populated connector instance values based on your Kafka setup and the message (JSON payload) that you received from the Kafka topic with <field_mappings> value.
    6. Optional: In the Connector Instance Values section, you can edit the values of the mandatory Kafka parameters.
      For details on the connector instance value parameters, see Kafka connector instance value parameters.
    7. Right-click the form header and select Save.
    8. Test the connection between the MID Server and the Kafka Metric Consumer connector.
      • Select Test Connector.
      • If the test connection fails, verify whether the credential is valid, and that the network is connected from the MID Server to the Kafka broker.
        Note:
        Kafka topic name validation occurs only in Test Connector validation.
    9. After a successful test, make the connector instance active by selecting the Active check box.
    10. Select Update.