Configure REST API integrations

Configure an integration for streaming log data to your ServiceNow instance in JSON format for processing by Health Log Analytics.

Before you begin

• Ensure that the Health Log Analytics application is installed and provisioned on your instance. For more information, see Health Log Analytics installation.
• Ensure that a service instance is available.
• Ensure that the Health Log Analytics AI Engine is up and running.

• You must have a configured MID Web Server with the log ingestion capability enabled.

  On the MID Web Server Context form, in the Execute on field, select Specific MID Server and not the cluster option. In the MID Server field, select the specific MID Server to which the log data is pulled.

• If the IP address of the MID Server 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.

Note:

REST API integrations support only UTF-8 encoding for incoming data.

Role required: evt_mgmt_admin

Procedure

1. Navigate to Workspaces > Service Operations Workspace.
2. From the left pane, select the Integrations Launchpad icon ()
3. In the Browse integrations tab, enter REST in the search field.
4. Select the REST API integration tile.
   Note:

   If you started the integration process without meeting all the prerequisites listed in the Before you begin section, a message appears. You have the option to cancel the integration and complete the missing requirements, or continue in draft mode and fulfill them later. Keep in mind that you can only activate a configured integration when all the prerequisites are met.
5. On the Provide details form, fill in the fields.
   For a description of the fields, see REST API integration configuration fields.
6. Select Next.
7. Follow the instructions on the Set-up instruction screen to install the integration in your monitoring tool.
   1. Copy the provided URL.
      Note:

      The format of the URL is: http://(MID_SERVER_IP):(MID_WEB_SERVER_PORT)/ap1/mid/hla/raw, where /aps/mid/hla/raw is the endpoint.
   2. Paste the URL in the configuration of your third-party console where you're prompted to enter the URL for streaming logs to the MID Server.

   Note:

   The authentication method used for pushing logs on the provided URL must be same as the method set on the selected MID Web Server.
8. Select Activate to activate the integration.
   Note:

   You can only activate a configured integration when you have fulfilled all the prerequisites listed in the Before you begin section.
   The integration is activated and the Overview tab is displayed.
9. Optional: If you installed the integration in draft mode, perform these steps to activate it:
   1. Complete the integration prerequisites.
   2. In the Integrations Launchpad Installed integrations tab, under Waiting for your action, locate and select the integration.
   3. On the Set-up instruction tab, select Activate to activate the integration.

Result

Log data starts streaming to your ServiceNow instance. The tile for the integration is available in the Installed integrations tab on the Integrations Launchpad.

Users with the evt_mgmt_user role can use Event Management to monitor the logs and view the alerts that Health Log Analytics generates from them.

What to do next

Review the log data streaming status and sources of the integration on the Overview tab. Leverage the displayed information to refine how HLA reads the log data by adjusting your integration configuration. For more information, see Review log data streaming status and sources of an integration.

Note:

You can go directly from this tab to the Data Input Mapping, Source Type Structures, and Log Sources pages with context from the integration. If the log data is not properly mapped, structured, or sourced, you can go back and adjust the configuration of the integration.

1. Select the View menu icon ().
2. Choose the appropriate menu option.
3. Review the displayed information.
4. Adjust the integration configuration if needed.

• REST API integration configuration fields
  Description of the fields on the REST API integration configuration forms for Health Log Analytics.