Configure UDP integrations

  • Release version: Xanadu
  • Updated September 2, 2024
  • 2 minutes to read

    • Configure an integration for sending log data to your ServiceNow instance directly over a UDP socket.

    Before you begin

    • Verify that the Health Log Analytics application is installed and provisioned on your instance. For more information, see Health Log Analytics (HLA) installation.
    • Verify that a service instance is available.
    • Verify that the HLA Engine is up and running.
    • Ensure that a MID Server is installed and configured with the Log Ingestion capability enabled. For more information, see MID Server system requirements.

      MID Server configuration with Log Ingestion capability enabled.

      Important:
      Health Log Analytics does not support IPv6. To work with the application, configure the MID Server to IPv4.
    • If the MID Server IP address is exposed by network address translation (NAT), a load balancer, or a similar device, it must have a public IP address. In the MID Server properties, add a property named mid.public_ip with the public IP address as the value. For more information, see Create a MID Server property.

    Role required: evt_mgmt_admin

    Procedure

    1. Navigate to Workspaces > Service Operations Workspace.
    2. From the left pane, select the Integrations Launchpad icon (Integration Launchpad icon)
    3. In the Browse integrations tab, enter UDP in the search field.
    4. Select the UDP integration tile.
      Note:
      If you start an integration setup before meeting all prerequisites, a message appears. You can either cancel the setup and complete the prior requirements first, or continue in draft mode and complete them later. Note that you can't activate the integration until all prerequisites are met.
    5. On the Provide details form, fill in the fields.
      For a description of the fields, see the Provide details table in UDP integration configuration fields.
    6. Optional: Select Advanced Settings to set advanced configuration fields.
      For a description of the fields, see the Advanced Settings table in UDP integration configuration fields.
    7. Select Next.
    8. In the Setup instruction screen, follow the instructions on the screen to install the integration in the third-party console.
    9. Select Save draft.
    10. Select Activate to activate the integration.
      Note:
      You can only activate a configured integration when you have fulfilled all the integration prerequisites. If you installed the integration in draft mode, you can activate it later by performing these steps:
      1. Complete the integration prerequisites.
      2. In the Integrations Launchpad Installed integrations tab, under Waiting for your action, locate and select the integration.
      3. In the Set-up instruction screen, select Activate to activate the integration.

    Result

    The integration is activated and the Overview screen is displayed. The tile for the integration is available in the Installed integrations tab on the Integrations Launchpad.

    What to do next

    Leverage the information on the Overview tab to refine how HLA reads the log data. For more information, see Review log data streaming status and sources of an integration.
    Tip:
    Use the More options menu () to open the Data Input Mapping, Source Type Structures, or Log Sources pages with context from the integration. If your log data is not properly mapped, structured, or sourced, go back and adjust the configuration. If the Service Operations Workspace Log Analytics application is installed, the More options menu also provides direct access to the Log Viewer, where you can review raw log messages ingested by the integration.
    For more information, see: