Home

/kafka/clusters?gte={timestamp}&lt={timestamp}

Gets Kafka cluster metrics.

Request
GET http://unravel-host:3000/api/v1/kafka/clusters?gte={timestamp}&lt={timestamp}
Path parameters

None.

Query parameters

Name

Type

Description

gte

string

Start time. Format: YYYY-MM-DDTHH:MM:SS.NNNZ or Unix epoch time. Required.

lt

string

End time. Format: YYYY-MM-DDTHH:MM:SS.NNNZ or Unix epoch time. Required.

Response body

The response body is a JSON structure identified by cluster name containing cluster metrics.

Name

Type

Description

ActiveControllerCount-Value

integer

OfflinePartitionsCount-Value

integer

BytesInPerSec_newTopic1-OneMinuteRate

float

BytesOutPerSec___consumer_offsets-OneMinuteRate

float

MessagesInPerSec___consumer_offsets-OneMinuteRate

float

TotalFetchRequestsPerSec___consumer_offsets-OneMinuteRate

float

UnderReplicatedPartitions-Value

integer

Examples

Request:

curl -X GET "http://myserver.com:3000/api/v1/kafka/clusters?gte=2019-06-02T14:14:18%2B05:30&lt=2019-06-03T14:14:18%2B05:30" -H  "accept: application/json" -H  "Authorization: JWT token"

Response:

{
"QAHDP26B": {    
    "ActiveControllerCount-Value":1,
    "OfflinePartitionsCount-Value":43,
    "BytesInPerSec_newTopic1-OneMinuteRate":8.893181625e-314,
    "BytesOutPerSec___consumer_offsets-OneMinuteRate":5549.999999999995,
    "MessagesInPerSec___consumer_offsets-OneMinuteRate":49.99999999999996,
    "TotalFetchRequestsPerSec___consumer_offsets-OneMinuteRate":514.6005947658281,
    "UnderReplicatedPartitions-Value":0,
    }
}
In this section: