Set up a Vector Agent integration for Health Log Analytics

Set up a Vector Agent integration to enable Health Log Analytics to process log messages that are streaming into your ServiceNow instance via a Vector Agent.

Before you begin

• 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.
• 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.

• Verify that you have a vector.yaml file on your machine, or create one.

Role required: evt_mgmt_admin

About this task

If your organization uses Vector by Datadog to handle log data from multiple sources before sending it to Health Log Analytics, the log format HLA receives is distinct from other types. The Vector Agent integration enables HLA to detect and separate transport headers from inner log messages in this format. Only the inner messages are forwarded to the source type structure for processing.

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.

Procedure

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 Vector in the search field.
5. Select the Vector integration tile.
   Note:

   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 the Provide details table in Vector Agent integration configuration fields.
7. Select Next.
8. In the Set-up instruction screen, follow the instructions on the screen to install the integration in your third-party console.
   Update the vector.yaml file as explained in the steps.
9. Do one of the following:
   • If you completed all the prerequisites before starting the configuration, select Activate.

     In the pop-up window, select Test & Save to save the integration to the database and test connectivity. If an error is returned, adjust the configuration as suggested in the error message and then try to activate the integration again.

     When the test is successful, the integration is activated and 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.

What to do next

On the Overview tab, do the following:

• Use the displayed information to refine how Health Log Analytics reads the log data. For more information, see Review log streaming data and adjust integration settings in Health Log Analytics.
• 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. Use the Log Viewer to review raw log messages ingested by the integration. For more information, see:
  • Log data auto-mapping and mapping
  • Source type structure adjustment
  • Reviewing the logs for an alert on the Log Viewer in Health Log Analytics