Metrics

This API provides Prometheus compatible metrics data, and is provided by the Monitor plugin.

Get Metrics

GET /api/v2/metrics

Request Headers

Authorization Bearer <token>

Request Params

category optional, one of global, driver and appnode optional, filter with node name, only meaningful when category=driver or category=app

Response Status

  • 200 OK
  • 400 Bad request
  • 500 Internal server error

Response

text

  1. # HELP core_dumped Whether there is any core dump
  2. # TYPE core_dumped gauge
  3. core_dumped 0
  4. # HELP uptime_seconds Uptime in seconds
  5. # TYPE uptime_seconds counter
  6. uptime_seconds 314
  7. # HELP north_nodes_total Number of north nodes
  8. # TYPE north_nodes_total gauge
  9. north_nodes_total 1
  10. # HELP north_running_nodes_total Number of north nodes in running state
  11. # TYPE north_running_nodes_total gauge
  12. north_running_nodes_total 1
  13. # HELP north_disconnected_nodes_total Number of north nodes disconnected
  14. # TYPE north_disconnected_nodes_total gauge
  15. north_disconnected_nodes_total 1
  16. # HELP south_nodes_total Number of south nodes
  17. # TYPE south_nodes_total gauge
  18. south_nodes_total 1
  19. # HELP south_running_nodes_total Number of south nodes in running state
  20. # TYPE south_running_nodes_total gauge
  21. south_running_nodes_total 0
  22. # HELP south_disconnected_nodes_total Number of south nodes disconnected
  23. # TYPE south_disconnected_nodes_total gauge
  24. south_disconnected_nodes_total 1
  25. # HELP send_msgs_total Total number of messages sent
  26. # TYPE send_msgs_total counter
  27. send_msgs_total{node="data-stream-processing"} 0
  28. # HELP send_msg_errors_total Total number of errors sending messages
  29. # TYPE send_msg_errors_total counter
  30. send_msg_errors_total{node="data-stream-processing"} 0
  31. # HELP recv_msgs_total Total number of messages received
  32. # TYPE recv_msgs_total counter
  33. recv_msgs_total{node="data-stream-processing"} 0
  34. # HELP last_rtt_ms Last request round trip time in milliseconds
  35. # TYPE last_rtt_ms gauge
  36. last_rtt_ms{node="modbus"} 9999
  37. # HELP send_bytes Total number of bytes sent
  38. # TYPE send_bytes gauge
  39. send_bytes{node="modbus"} 0
  40. # HELP recv_bytes Total number of bytes received
  41. # TYPE recv_bytes gauge
  42. recv_bytes{node="modbus"} 0
  43. # HELP tag_reads_total Total number of tag reads including errors
  44. # TYPE tag_reads_total counter
  45. tag_reads_total{node="modbus"} 0
  46. # HELP tag_read_errors_total Total number of tag read errors
  47. # TYPE tag_read_errors_total counter
  48. tag_read_errors_total{node="modbus"} 0
  49. # HELP group_tags_total Total number of tags in the group
  50. # TYPE group_tags_total gauge
  51. group_tags_total{node="modbus",group="grp"} 1
  52. # HELP group_last_send_msgs Number of messages sent on last group timer invocation
  53. # TYPE group_last_send_msgs gauge
  54. group_last_send_msgs{node="modbus",group="grp"} 0
  55. # HELP group_last_timer_ms Time in milliseconds consumed on last group timer invocation
  56. # TYPE group_last_timer_ms gauge
  57. group_last_timer_ms{node="modbus",group="grp"} 0