How to Retrieve Cluster Metrics

Retrieving cluster metrics returns GPU and fabric performance data for all instances in a cluster. This is useful for monitoring cluster health, identifying performance bottlenecks, and tracking resource utilization.

This guide explains how to retrieve cluster metrics using the Vultr API.

1. Send a GET request to the List Clusters endpoint to retrieve all clusters.

   CONSOLE

   Copy

   $ curl "https://api.vultr.com/v2/clusters" \
       -X GET \
       -H "Authorization: Bearer ${VULTR_API_KEY}"

   Explain Code

   Powered by Vultr AgentBeta

   Note the id of the cluster for which you want to retrieve metrics.

2. Send a GET request to the Get Cluster Metrics endpoint to retrieve metrics for the cluster. Replace {cluster-id} with the cluster id. Optionally add the period query parameter to specify the time range: -1days (default), -7days, or -30days.

   CONSOLE

   Copy

   $ curl "https://api.vultr.com/v2/clusters/{cluster-id}/metrics?period=-7days" \
       -X GET \
       -H "Authorization: Bearer ${VULTR_API_KEY}"

   Explain Code

   Powered by Vultr AgentBeta

   The response contains GPU and fabric metrics for all instances in the cluster.