Viewing Monitoring Metrics

Updated on 2024-05-20 GMT+08:00

View PDF

Function

This API is used to view monitoring metrics, including node metrics and graph instance performance monitoring metrics.

URI

GET /ges/v1.0/{project_id}/graphs/{graph_name}/om/metrics?real_time=&with_performance_metrics=

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For how to obtain the project ID, see Obtaining a Project ID.
graph_name	Yes	String	Graph name
real_time	No	Boolean	Whether to query real-time monitoring metrics. The value can be true or false. The default value is false. false: Metrics for a graph instance within 2 minutes are queried. true: Real-time monitoring metrics are queried, and the query is responded to in 3 to 5 seconds.
with_performance_metrics	No	Boolean	Whether to query performance metrics. The graph instance performance metrics and metrics of each node are returned. The value can be true or false. The default value is true. If set to true, only node metrics are returned, and the response time is reduced by 1 to 2 seconds.

Request Parameters

None

Response Parameters

**Table 2** Response body parameters
Parameter	Type	Description
errorMessage	String	System prompt If the execution succeeds, this parameter may be left blank. If the execution fails, this parameter is used to display the error message.
errorCode	String	System prompt code If the execution succeeds, this parameter may be left blank. If the execution fails, this parameter is used to display the error code.
project_id	String	Schema structure query result For details, see Table 5-117.
id	String	Graph ID
name	String	Graph name
timestamp	long	Current timestamp
node_metrics	List<NodeMetrics>	Node metrics
performance_metrics	Object	Performance metrics

**Table 3** NodeMetrics parameter description
Parameter	Type	Description
overview	String	Node overview
disk_details	List<DiskDetail>	Disk details of the node
network_details	List<NetworkDetail>	Network details of the node

**Table 4** overview parameter description
Parameter	Type	Description
ges_instance_name	String	Node name
instance_id	String	Node ID
work_ip	String	Number of vertices with the label
role	String	Node role
cpu_usage	Double	CPU usage
cpu_usage_usr	Double	CPU usage in user mode
cpu_usage_sys	Double	CPU usage in kernel mode
cpu_iowait	Double	CPU I/O wait rate
cpu_idle	Double	CPU idle rate
mem_total	Double	Total memory size, in GB
mem_usage	Double	Used memory size, in GB
mem_free	Double	Available memory size, in GB
mem_cached	Double	Memory cache size, in GB
mem_buffer	Double	Memory buffer size, in GB
disk_total	Double	Total disk space, in GB
disk_usage_avg	Double	Average disk usage
disk_used	Double	Used disk space, in GB
disk_available	Double	Total available disk space, in GB
disk_io_read	Double	Disk read rate of a node, in KB/s
disk_io_write	Double	Disk read rate of a node, in KB/s
swap_total	Double	Total swap disk space of a node
swap_free	Double	Remaining swap disk space of a node
network_io_rate	Double	Network I/O rate of a node, in KB/s
host_stat	Integer	Node status

**Table 5** DiskDetail parameter description
Parameter	Type	Description
disk_name	String	Disk name
disk_type	String	Disk type
total	Double	Total disk space
available	Double	Available disk space
used	Double	Used disk space
used_percentage	Integer	Disk usage
svctm	Long	Disk I/O service time, in milliseconds
await	Long	Disk I/O wait time, in milliseconds
util	Double	Disk I/O usage
write_rate	Double	Disk read rate
read_rate	Double	Disk write rate

**Table 6** NetworkDetail parameter description
Parameter	Type	Description
status	Integer	NIC status
interface_name	String	NIC name
packets_recv	Long	Number of received packets
packets_send	Long	Number of sent packets
packets_drop	Long	Number of lost packets
send_rate	Double	Sending rate, in KB/s
recv_rate	Double	Receiving rate, in KB/s

**Table 7** performance_metrics parameter description
Parameter	Type	Description
cpu_usage	Double	CPU usage
memory_usage	Double	Memory usage
disk_usage	Double	Average disk usage
disk_io_rate	Double	Disk I/O rate
network_io_rate	Double	Network I/O rate
swap_disk_usage	Double	Swap disk usage
tomcat_connections_usage	Double	Tomcat connection usage
qps	Long	Number of requests per second
vertex_number	Long	Number of vertices
vertex_capacity	Long	Vertex capacity
vertex_usage	Double	Vertex usage
edge_number	Long	Number of edges
edge_capacity	Long	Edge capacity
edge_usage	Double	Edge usage
read_waiting_queue_length	Long	Length of the read waiting queue
read_running_queue_length	Long	Length of the read running queue
write_waiting_queue_length	Long	Length of the write waiting queue
write_running_queue_length	Long	Length of the write running queue

Example Request

GET http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/ om/metrics?real_time=true

Example Response

Status code: 200

Example response for a successful request

{
  "project_id": "xxx",
  "id": "xxxxx",
  "name": "baiwan_demo",
  "timestamp": 1699506387592,
  "node_metrics": [
    {
      "overview": {
        "network_io_rate": 2.99,
        "role": "slave",
        "disk_io_write": 107.23,
        "mem_cached": 2.57,
        "cpu_usage_usr": 7.15,
        "cpu_usage_sys": 3.07,
        "disk_io_read": 3.03,
        "ges_instance_name": "baiwan_demo-ges-cn-cn-2-1",
        "disk_used": 5.48,
        "swap_total": 0,
        "mem_buffer": 192.5,
        "disk_available": 144.47,
        "cpu_iowait": 0.17,
        "cpu_idle": 89.61,
        "mem_total": 15.15,
        "instance_id": "xxxxxxxx",
        "mem_usage": 7.22,
        "disk_total": 149.95,
        "host_stat": 200,
        "mem_free": 11.29,
        "swap_free": 0,
        "cpu_usage": 10.22,
        "disk_usage_avg": 3.65,
        "work_ip": "172.16.25.224",
        "host_name": "baiwan_demo-ges-cn-cn-2-1"
      },
      "disk_details": [
        {
          "svctm": 0,
          "total": 50,
          "util": 0.61,
          "write_rate": 96.48,
          "disk_name": "vda",
          "disk_type": "system",
          "used_percentage": 0.09,
          "available": 45.68,
          "await": 18.16,
          "read_rate": 2.99,
          "used": 4.32
        }
      ],
      "network_details": [
        {
          "send_rate": 0.05,
          "packets_drop": 0,
          "packets_recv": 1001419,
          "packets_send": 342518,
          "interface_name": "eth0",
          "recv_rate": 0.06,
          "status": 1
        }
      ]
    }
  ],
  "performance_metrics": {
    "tomcat_connections_usage": 0,
    "network_io_rate": 3.11,
    "swap_disk_usage": 0,
    "vertex_capacity": 1200000,
    "memory_usage": 23.83,
    "vertex_number": 1071803,
    "jvm_heap_usage": 0.23,
    "edge_capacity": 1200000,
    "read_waiting_queue_length": 0,
    "disk_io_rate": 0,
    "qps": 0,
    "write_running_queue_length": 0,
    "write_waiting_queue_length": 0,
    "disk_usage": 1.77,
    "edge_number": 1200000,
    "edge_usage": 100,
    "cpu_usage": 9.23,
    "read_running_queue_length": 0,
    "vertex_usage": 89.32
  }
}

Status code: 400

Example response for a failed request

Http Status Code: 400 
{ 
    "errorMessage": "query metrics error.", 
    "errorCode": "GES.8602" 
}

Error Codes

See Error Codes for Service Plane APIs.

Parent topic: O&M Monitoring APIs

Previous topic: O&M Monitoring APIs

Next topic: Viewing Real-Time Requests

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot