Health Log Analytics (HLA) installation

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

    • Request ServiceNow Health Log Analytics installation from ServiceNow Customer Support.

    Before you begin

    The minimum version of the ServiceNow AI Platform required for Health Log Analytics installation is Xanadu.

    Important:
    Health Log Analytics uses the default user sn_occ_occultus for internal communication. Make sure that this user is active and do not deactivate it.

    Role required: admin

    Procedure

    1. Ensure that the Health Log Analytics application and all of its associated ServiceNow Store applications have valid ServiceNow entitlements.
      To obtain the entitlements, contact your ServiceNow Solution Consultant.
    2. Opt into the ITOM Health product.
      1. Go to the ServiceNow Store website and search for the Health Log Analytics app.
        Figure 1. Health Log Analytics app in the ServiceNow Store
        The Health Log Analytics app in the ServiceNow Store.
      2. Select Health Log Analytics.
        The Health Log Analytics product page displays.
        Figure 2. Health Log Analytics product page in the ServiceNow Store
        The Health Log Analytics app product page in the ServiceNow Store.
      3. Select View Products.
      4. Select Opt-in.
        Figure 3. ITOM Health product
        The ITOM Health product.
    3. Install the Health Log Analytics application on your instance.
      1. Navigate to System Applications > All Available Applications > All.
      2. Find the Health Log Analytics application using the search bar.
      3. On the Health Log Analytics tile, select Install.
        When the application is successfully installed on the instance, an automatic change request (CHG) is triggered to request provisioning for the necessary endpoints. The instance admin receives the request and any relevant notifications.
        Note:
        Even when the Health Log Analytics application is successfully installed, it will not work until the endpoints have been provisioned.
      4. Ensure that the application and its dependencies were installed successfully, as illustrated in the figure.
        Figure 4. Health Log Analytics is installed on the instance
        Health Log Analytics is installed on the instance.
    4. Optional: Observe the status of the provisioning process by reviewing the CHG.
      Note:
      Some steps in the provisioning process might require your explicit approval. In such cases, ServiceNow Customer Support will reach out.
    5. When provisioning is completed, ensure that the Health Log Analytics application is up and running.
      1. In the Filter navigator, enter sn_occ_stats.do.
        The Health Log Analytics Package Dependencies and Versions table displays.
        Figure 5. Health Log Analytics Package Dependencies and Versions table
        Health Log Analytics Package Dependencies and Versions table.
        The provisioned endpoints are listed along with their version number:
        • Occultus
        • MetricBase
        • ElasticSearch

    Result

    The Health Log Analytics application is installed and provisioned on your instance.

    What to do next