Querying Kafka Instance Monitoring Dimensions
This API is out-of-date and may not be maintained in the future. Please use the API described in Querying Kafka Instance Monitoring Dimensions.
URI
GET /v1.0/dms/{project_id}/instances/{instance_id}/ceshierarchy
Table 1 describes the response parameters.
Request
Request parameters
None.
Example request
None.
Response
Response parameters
Table 2 describes the response parameters.
| Parameter | Type | Description |
|---|---|---|
| dimensions | Array of object dimensions | Monitoring dimensions. For details about the parameters, see Table 3. |
| instance_ids | Array of object instance_ids | Instance information. For details about the parameter, see Table 4. |
| nodes | Array of object nodes | Broker information. For details about the parameter, see Table 5. |
| queues | Array of object queues | Topic information. For details about the parameters, see Table 6. |
| groups | Array of object groups | Consumer group information. For details about the parameters, see Table 7. |
| Parameter | Type | Description |
|---|---|---|
| name | String | Monitoring dimension name. |
| metrics | Array of object metrics | Metric name. For details about the metrics, see Table 10. |
| key_name | Array of object key_name | Key used for monitoring query. |
| dim_router | Array of object dim_router | Monitoring dimension route. |
| children | Array of object children | List of sub-dimensions. For details about the parameters, see Table 8. |
| Parameter | Type | Description |
|---|---|---|
| name | String | Topic name. |
| partitions | Array of object partitions | Partition list. For details, see Table 9. |
| Parameter | Type | Description |
|---|---|---|
| name | String | Consumer group name. |
| queues | Array of object queues | Topic information. |
| Parameter | Type | Description |
|---|---|---|
| name | String | Secondary dimension name. |
| metrics | Array of String | Metrics on the secondary dimension. For details, see Table 10. |
| key_name | Array of String | Key used for monitoring query. |
| dim_router | Array of String | Monitoring dimension route. |
| Dimension | Metric ID | Description |
|---|---|---|
| kafka_instance_id (Kafka instances) | current_topics | Number of created topics in the instance. |
| current_partitions | Number of used partitions in the instance. | |
| group_messages | Total number of accumulated messages in all consumer groups of the instance. | |
| kafka_broker (Kafka brokers) | broker_data_size | Total size of messages in the broker. |
| broker_messages_in_rate | Number of messages produced per second. | |
| broker_bytes_out_rate | Number of bytes consumed per second. | |
| broker_bytes_in_rate | Number of bytes produced per second. | |
| broker_public_bytes_in_rate | Inbound traffic over public networks per second. | |
| broker_public_bytes_out_rate | Outbound traffic over public networks per second. | |
| broker_produce_mean | Average time that the broker spends processing message production requests. | |
| broker_fetch_mean | Average time that the broker spends processing message consumption requests. | |
| kafka_topics (Topics) | topic_data_size | Total number of messages in the topic. |
| topic_messages_in_rate | Number of messages produced per second. | |
| topic_bytes_out_rate | Number of bytes consumed per second. | |
| topic_bytes_in_rate | Number of bytes produced per second. | |
| topic_messages | Total number of messages in the topic. | |
| kafka_partitions (Partitions) | produced_messages | Total number of messages in the partition. |
| partition_messages | Number of messages that have been created in the partition. | |
| messages_consumed | Number of messages that have been consumed in the partition. | |
| messages_remained | Number of remaining messages that can be consumed in the partition. | |
| kafka_groups_partitions (Consumer groups) | messages_consumed | Number of messages that have been retrieved by the consumer group. |
| messages_remained | Number of remaining messages that can be consumed by the consumer group. |
Example response
{
"dimensions": [{
"name": "kafka_instance_id",
"metrics": ["current_partitions",
"current_topics",
"group_messages"],
"key_name": ["instance_ids"],
"dim_router": ["kafka_instance_id"]
},
{
"name": "kafka_broker",
"metrics": ["broker_data_size",
"broker_messages_in_rate",
"broker_bytes_out_rate",
"broker_bytes_in_rate",
"broker_produce_mean",
"broker_fetch_mean"],
"key_name": ["nodes"],
"dim_router": ["kafka_instance_id",
"kafka_broker"]
},
{
"name": "kafka_rest",
"metrics": ["rest_produce_success",
"rest_produce_failed",
"rest_produce_latency",
"rest_produce_msg_num",
"rest_produce_flow",
"rest_consume_success",
"rest_consume_failed",
"rest_consume_latency",
"rest_consume_msg_num",
"rest_consume_flow",
"rest_commit_success",
"rest_commit_failed",
"rest_commit_latency",
"rest_commit_msg_num",
"rest_commit_flow"],
"key_name": ["nodes"],
"dim_router": ["kafka_instance_id",
"kafka_rest"]
},
{
"name": "kafka_topics",
"metrics": ["topic_data_size",
"topic_messages_in_rate",
"topic_bytes_out_rate",
"topic_bytes_in_rate",
"topic_messages"],
"key_name": ["queues"],
"dim_router": ["kafka_instance_id",
"kafka_topics"],
"children": [{
"name": "kafka_partitions",
"metrics": ["produced_messages",
"partition_messages"],
"key_name": ["queues",
"partitions"],
"dim_router": ["kafka_instance_id",
"kafka_topics",
"kafka_partitions"]
}]
},
{
"name": "kafka_groups_partitions",
"metrics": ["messages_consumed",
"messages_remained"],
"key_name": ["groups",
"queues",
"partitions"],
"dim_router": ["kafka_instance_id",
"kafka_groups",
"kafka_groups_topics",
"kafka_groups_partitions"]
}],
"instance_ids": [{
"name": "68f3f6a0-3741-453b-bda9-a6ff6b5bb6f7"
}],
"nodes": [{
"name": "broker-0"
},
{
"name": "broker-1"
},
{
"name": "broker-2"
}],
"queues": [{
"name": "aaaa",
"partitions": [{
"name": "0"
}]
},
{
"name": "mytest",
"partitions": [{
"name": "0"
},
{
"name": "1"
},
{
"name": "2"
}]
},
{
"name": "topic-84234378",
"partitions": [{
"name": "0"
},
{
"name": "1"
},
{
"name": "2"
}]
}],
"groups": [{
"name": "test-consumer-group",
"queues": [{
"name": "mytest",
"partitions": [{
"name": "0"
},
{
"name": "1"
},
{
"name": "2"
}]
}]
}]
} Last Article: Querying Maintenance Time Windows
Next Article: Appendix
Did this article solve your problem?
Thank you for your score！Your feedback would help us improve the website.