query_cluster_metrics
Retrieve performance metrics for a Zilliz Cloud cluster, including compute usage, storage, request counts, latency, and success rates over specified time periods.
Instructions
Query the metrics of a specific cluster.
Args:
cluster_id: ID of the target cluster
start: Starting date and time in ISO 8601 timestamp format (optional, use with end)
end: Ending date and time in ISO 8601 timestamp format (optional, use with start)
period: Duration in ISO 8601 duration format (optional, use when start/end not set)
granularity: Time interval for metrics reporting in ISO 8601 duration format (minimum PT30S)
metric_queries: List of metric queries, each containing 'metricName' and 'stat' fields
- metricName: Name of the metric. Available options:
* CU_COMPUTATION - Compute unit computation usage
* CU_CAPACITY - Compute unit capacity
* STORAGE_USE - Storage usage
* REQ_INSERT_COUNT - Insert request count
* REQ_BULK_INSERT_COUNT - Bulk insert request count
* REQ_UPSERT_COUNT - Upsert request count
* REQ_DELETE_COUNT - Delete request count
* REQ_SEARCH_COUNT - Search request count
* REQ_QUERY_COUNT - Query request count
* VECTOR_REQ_INSERT_COUNT - Vector insert request count
* VECTOR_REQ_UPSERT_COUNT - Vector upsert request count
* VECTOR_REQ_SEARCH_COUNT - Vector search request count
* REQ_INSERT_LATENCY_P99 - Insert request latency P99
* REQ_BULK_INSERT_LATENCY_P99 - Bulk insert request latency P99
* REQ_UPSERT_LATENCY_P99 - Upsert request latency P99
* REQ_DELETE_LATENCY_P99 - Delete request latency P99
* REQ_SEARCH_LATENCY_P99 - Search request latency P99
* REQ_QUERY_LATENCY_P99 - Query request latency P99
* REQ_SUCCESS_RATE - Request success rate
* REQ_FAIL_RATE - Request failure rate
* REQ_FAIL_RATE_INSERT - Insert request failure rate
* REQ_FAIL_RATE_BULK_INSERT - Bulk insert request failure rate
* REQ_FAIL_RATE_UPSERT - Upsert request failure rate
* REQ_FAIL_RATE_DELETE - Delete request failure rate
* REQ_FAIL_RATE_SEARCH - Search request failure rate
* REQ_FAIL_RATE_QUERY - Query request failure rate
* ENTITIES_LOADED - Number of loaded entities
* ENTITIES_INSERT_RATE - Entity insert rate
* COLLECTIONS_COUNT - Collection count
* ENTITIES_COUNT - Total entity count
- stat: Statistical method (AVG for average, P99 for 99th percentile - P99 only valid for latency metrics)
Returns:
Dict containing cluster metrics data
Example:
{
"code": 0,
"data": {
"results": [
{
"name": "CU_COMPUTATION",
"stat": "AVG",
"unit": "percent",
"values": [
{
"timestamp": "2024-06-30T16:09:53Z",
"value": "1.00"
}
]
}
]
}
}
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cluster_id | Yes | ||
| start | No | ||
| end | No | ||
| period | No | ||
| granularity | No | PT30S | |
| metric_queries | No |