Set up a REST API integration for Health Log Analytics

Set up an integration for streaming log data to your ServiceNow instance for processing by Health Log Analytics.

Avant de commencer

• Verify that the Health Log Analytics application is installed and provisioned on your instance. For more information, see Install Health Log Analytics (HLA).
• Verify that a service instance is available.
• Verify that the Health Log Analytics AI Engine is up and running.

• Verify that a MID Server is installed and configured with the Log Ingestion capability enabled. For more information, see MID Server system requirements.

  

  Important :

  Health Log Analytics does not support IPv6. To work with the application, configure the MID Server to IPv4.

  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.

• Unless the MID Server and external clients are on the same network, the MID Server must have a public IP address. This is required when its IP is exposed through network address translation (NAT), a load balancer, or a similar device. The public IP address enables external clients, such as Filebeat agents located outside its network, to reach the MID Server. Private IP addresses are not routable over the internet. Without a public IP, external clients cannot connect to the MID Server even if they are configured with its 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. If the MID Server and external clients are on the same network, connections can be made using the private IP address.

Remarque :

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

Role required: evt_mgmt_admin

Pourquoi et quand exécuter cette tâche

You set up integrations through the Integrations Launchpad in Service Operations Workspace, which you access from the ITOM AIOps configuration center. The AIOps configuration center is a centralized workspace for configuring and managing AIOps features from a single place. The integrations setup process reduces implementation time compared to manual data input setup in the classic interface in Health Log Analytics. For more information, see Integrations Launchpad in Service Operations Workspace for ITOM.

Procédure

1. Navigate to Workspaces > Service Operations Workspace.
2. From the bottom of the navigation pane, select the AIOps configuration center icon .
   The ITOM AIOps configuration center page appears. The configuration center is a centralized workspace. Use it to configure and manage AIOps features from a single place.
3. From the Integrate section, under Integrations, select Add integration.
   The Integrations Launchpad appears.
4. In the Browse integrations tab, enter REST in the search field.
5. Select the REST API integration tile.
   Remarque :

   If you start an integration setup before meeting all prerequisites, a message appears. You can cancel the setup and complete the prior requirements first. Alternatively, you can continue in draft mode and complete the requirements later. Note that you can't activate the integration until you have completed all the prerequisites.
6. On the Provide details form, fill in the fields.
   For a description of the fields, see REST API integration configuration fields.
7. Select Next.
8. In the Set-up instruction screen, copy the provided URL to the clipboard.

   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. HLA has replaced (MID_SERVER_IP) and (MID_WEB_SERVER_PORT) with the values you configured on the Provide details form.

9. Do one of the following:
   • If you completed all the prerequisites before starting the configuration, select Activate.

     When the integration is activated successfully, the Overview tab is displayed. On the Integrations Launchpad, the integration tile is available in the Installed integrations tab.

   • If you didn't complete all the prior requirements, select Save draft.

     The system saves the integration as a draft in the Integrations Launchpad. It appears in the Installed integrations tab, under Waiting for your action. You can complete the prerequisites and activate the integration later. For more information, see Activate a draft integration in Health Log Analytics.

Que faire ensuite

Instruct your API client to send log messages to the MID Server.

1. In the API client, configure a request with the following parameters:
   • HTTP Method: POST.
   • URL: The URL you copied in the Set-up instruction screen.
   • Authentication: The required authentication credentials. For example, Basic authentication (username and password).
     Remarque :

     The authentication method must be the same as the method configured on the MID Web Server.
   • Headers: Set the Content-Type header to match your payload format.
     • For JSON: application/json.
     • For raw text: text/plain.
   • Body: The logs payload in JSON or raw text.
2. Send the request.

   A successful response indicates that the MID Server has received the payload. When the MID Server has processed the log messages, the data input streams them to your ServiceNow instance using the REST protocol.