Home

/kafka/{cluster_name}/kpi?broker={broker_name}?start_time={timestamp}&end_time={timestamp}&interval={minutes}&prefix={metrics}

Gets KPIs for a given Kafka broker.

Request
GET http://unravel-host:3000/api/v1/kafka/{cluster_name}/kpi?broker={broker_name}?start_time={timestamp}&end_time={timestamp}&interval={minutes}&prefix={metrics}
Path parameters

Name

Description

cluuster_name

Cluster name.

Query parameters

Required parameters are highlighted.

Name

Type

Description

broker

string

Broker name.

start_time

string

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

end_time

string

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

interval

string

Interval size, in minutes.

Valid values are 1m, 5m, 10m, 30m.

prefix

string

List of metrics to graph. Separate each metric with +.

Valid values are:

BytesInPerSec
BytesOutPerSec
MessagesInPerSec
TotalFetchRequestsPerSec
UnderReplicatedPartitions
ActiveControllerCount
RequestHandlerAvgIdlePercent-OneMinuteRate
PartitionCount-Value
LeaderCount-Value
OfflinePartitionsCount
TotalTimeMs_Fetch-99thPercentile
RequestsPerSec_Fetch-OneMinuteRate
RequestsPerSec_Produce-OneMinuteRate
PurgatorySize_Produce-Value
PurgatorySize_Fetch-Value
Response body

The response is one array per broker, with the following KPIs:

Name

Type

Description

ts

string

Timestamp.

avg_vd

string

Examples

Request:

curl -X GET "http://myserver.com:3000/api/v1/kafka/QAHDP26B/kpi?broker=QAHDP26B.kafka1
&end_time=2019-06-03T16:56:09%2B05:30&interval=1m&prefix=BytesInPerSec&start_time=2019-06-03T15:56:09%2B05:30" -H  "accept: application/json" -H  "Authorization: JWT token"

Response:

{"QAHDP26B.kafka2":[{"ts":1559559780000,"avg_vd":"504.710000000000"}]}
In this section: