Monitoring VMware Aria Operations Appliance Health Status (Self-Monitoring)

Products

• VCF Operations/Automation (formerly VMware Aria Suite)
• VMware Aria Operations 8.x

Issue/Introduction

• This article provides guidance on monitoring the health of a VMware Aria Operations appliance using both the built-in UI dashboards and the Aria Operations API.
• This allows administrators to proactively identify and address potential issues affecting the appliance's performance and availability.

Environment

VMware Aria Operations 8.x

Resolution

1. UI Dashboard Monitoring:

• Aria Operations includes pre-configured self-monitoring dashboards, which are activated by default.
• These dashboards can be found by navigating to Operations > Dashboard > Expand "ALL" folder > VMware Aria Operations.
  
• Refer to the official Aria Operations Self-Monitoring documentation for detailed information on the available dashboards and their metrics.

2. API Monitoring:

• Use the APIs with Get calls. 

Set Up Authentication

• Most APIs require some form of authentication. This could be an API key, OAuth token, or other methods. Ensure you have the necessary credentials.
• The Aria Operations API can be accessed at: https://operations_ip_or_fqdn/suite-api.

Authentication:

• Click "Authorize" and enter the administrator username and password.
• Retrieve an authentication token by making a POST request to /suite-api/api/auth/token/acquire with the following JSON payload:

{
    "username": "admin",
    "authSource": "local",
    "password": "<Your Password>"
}

Make API Calls

• Use tools like Postman, curl, or your programming language's HTTP libraries to make requests to the API endpoints.

             For ex: curl -k -v -X GET "https://<IP/FQDN>/suite-api/api/deployment/node/status?services=locator" -H "Authorization: Bearer <YOUR_TOKEN>"

Service Status Calls

    https://<IP/FQDN>/suite-api/api/deployment/node/status?services=locator
    https://<IP/FQDN>/suite-api/api/deployment/node/status?services=casa
    https://<IP/FQDN>/suite-api/api/deployment/node/status?services=ui
    https://<IP/FQDN>/suite-api/api/deployment/node/status?services=collector
    https://<IP/FQDN>/suite-api/api/deployment/node/status?services=analytics
    https://<IP/FQDN>/suite-api/api/deployment/node/status?services=api
    https://<IP/FQDN>/suite-api/api/deployment/node/status?services=adminui

Multiple Services Status Calls

    https://<IP/FQDN>/suite-api/api/deployment/node/status?services=analytics&services=collector
    https://<IP/FQDN>/suite-api/api/deployment/node/status?services=casa&services=ui&services=adminui

Node Status Call

    https://<IP/FQDN>/suite-api/api/deployment/node/status

NOTE: Replace <IP/FQDN> with the actual IP address or fully qualified domain name of your Aria Operations primary node