Metrics.cpp 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272
  1. /*
  2. * Copyright (c)2013-2023 ZeroTier, Inc.
  3. *
  4. * Use of this software is governed by the Business Source License included
  5. * in the LICENSE.TXT file in the project's root directory.
  6. *
  7. * Change Date: 2025-01-01
  8. *
  9. * On the date above, in accordance with the Business Source License, use
  10. * of this software will be governed by version 2.0 of the Apache License.
  11. */
  12. #include <prometheus/simpleapi.h>
  13. #include <prometheus/histogram.h>
  14. namespace prometheus {
  15. namespace simpleapi {
  16. std::shared_ptr<Registry> registry_ptr = std::make_shared<Registry>();
  17. Registry& registry = *registry_ptr;
  18. SaveToFile saver;
  19. }
  20. }
  21. namespace ZeroTier {
  22. namespace Metrics {
  23. // Packet Type Counts
  24. prometheus::simpleapi::counter_family_t packets
  25. { "zt_packet", "ZeroTier packet type counts"};
  26. // Incoming packets
  27. prometheus::simpleapi::counter_metric_t pkt_nop_in
  28. { packets.Add({{"packet_type", "nop"}, {"direction", "rx"}}) };
  29. prometheus::simpleapi::counter_metric_t pkt_error_in
  30. { packets.Add({{"packet_type", "error"}, {"direction", "rx"}}) };
  31. prometheus::simpleapi::counter_metric_t pkt_ack_in
  32. { packets.Add({{"packet_type", "ack"}, {"direction", "rx"}}) };
  33. prometheus::simpleapi::counter_metric_t pkt_qos_in
  34. { packets.Add({{"packet_type", "qos"}, {"direction", "rx"}}) };
  35. prometheus::simpleapi::counter_metric_t pkt_hello_in
  36. { packets.Add({{"packet_type", "hello"}, {"direction", "rx"}}) };
  37. prometheus::simpleapi::counter_metric_t pkt_ok_in
  38. { packets.Add({{"packet_type", "ok"}, {"direction", "rx"}}) };
  39. prometheus::simpleapi::counter_metric_t pkt_whois_in
  40. { packets.Add({{"packet_type", "whois"}, {"direction", "rx"}}) };
  41. prometheus::simpleapi::counter_metric_t pkt_rendezvous_in
  42. { packets.Add({{"packet_type", "rendezvous"}, {"direction", "rx"}}) };
  43. prometheus::simpleapi::counter_metric_t pkt_frame_in
  44. { packets.Add({{"packet_type", "frame"}, {"direction", "rx"}}) };
  45. prometheus::simpleapi::counter_metric_t pkt_ext_frame_in
  46. { packets.Add({{"packet_type", "ext_frame"}, {"direction", "rx"}}) };
  47. prometheus::simpleapi::counter_metric_t pkt_echo_in
  48. { packets.Add({{"packet_type", "echo"}, {"direction", "rx"}}) };
  49. prometheus::simpleapi::counter_metric_t pkt_multicast_like_in
  50. { packets.Add({{"packet_type", "multicast_like"}, {"direction", "rx"}}) };
  51. prometheus::simpleapi::counter_metric_t pkt_network_credentials_in
  52. { packets.Add({{"packet_type", "network_credentials"}, {"direction", "rx"}}) };
  53. prometheus::simpleapi::counter_metric_t pkt_network_config_request_in
  54. { packets.Add({{"packet_type", "network_config_request"}, {"direction", "rx"}}) };
  55. prometheus::simpleapi::counter_metric_t pkt_network_config_in
  56. { packets.Add({{"packet_type", "network_config"}, {"direction", "rx"}}) };
  57. prometheus::simpleapi::counter_metric_t pkt_multicast_gather_in
  58. { packets.Add({{"packet_type", "multicast_gather"}, {"direction", "rx"}}) };
  59. prometheus::simpleapi::counter_metric_t pkt_multicast_frame_in
  60. { packets.Add({{"packet_type", "multicast_frame"}, {"direction", "rx"}}) };
  61. prometheus::simpleapi::counter_metric_t pkt_push_direct_paths_in
  62. { packets.Add({{"packet_type", "push_direct_paths"}, {"direction", "rx"}}) };
  63. prometheus::simpleapi::counter_metric_t pkt_user_message_in
  64. { packets.Add({{"packet_type", "user_message"}, {"direction", "rx"}}) };
  65. prometheus::simpleapi::counter_metric_t pkt_remote_trace_in
  66. { packets.Add({{"packet_type", "remote_trace"}, {"direction", "rx"}}) };
  67. prometheus::simpleapi::counter_metric_t pkt_path_negotiation_request_in
  68. { packets.Add({{"packet_type", "path_negotiation_request"}, {"direction", "rx"}}) };
  69. // Outgoing packets
  70. prometheus::simpleapi::counter_metric_t pkt_nop_out
  71. { packets.Add({{"packet_type", "nop"}, {"direction", "tx"}}) };
  72. prometheus::simpleapi::counter_metric_t pkt_error_out
  73. { packets.Add({{"packet_type", "error"}, {"direction", "tx"}}) };
  74. prometheus::simpleapi::counter_metric_t pkt_ack_out
  75. { packets.Add({{"packet_type", "ack"}, {"direction", "tx"}}) };
  76. prometheus::simpleapi::counter_metric_t pkt_qos_out
  77. { packets.Add({{"packet_type", "qos"}, {"direction", "tx"}}) };
  78. prometheus::simpleapi::counter_metric_t pkt_hello_out
  79. { packets.Add({{"packet_type", "hello"}, {"direction", "tx"}}) };
  80. prometheus::simpleapi::counter_metric_t pkt_ok_out
  81. { packets.Add({{"packet_type", "ok"}, {"direction", "tx"}}) };
  82. prometheus::simpleapi::counter_metric_t pkt_whois_out
  83. { packets.Add({{"packet_type", "whois"}, {"direction", "tx"}}) };
  84. prometheus::simpleapi::counter_metric_t pkt_rendezvous_out
  85. { packets.Add({{"packet_type", "rendezvous"}, {"direction", "tx"}}) };
  86. prometheus::simpleapi::counter_metric_t pkt_frame_out
  87. { packets.Add({{"packet_type", "frame"}, {"direction", "tx"}}) };
  88. prometheus::simpleapi::counter_metric_t pkt_ext_frame_out
  89. { packets.Add({{"packet_type", "ext_frame"}, {"direction", "tx"}}) };
  90. prometheus::simpleapi::counter_metric_t pkt_echo_out
  91. { packets.Add({{"packet_type", "echo"}, {"direction", "tx"}}) };
  92. prometheus::simpleapi::counter_metric_t pkt_multicast_like_out
  93. { packets.Add({{"packet_type", "multicast_like"}, {"direction", "tx"}}) };
  94. prometheus::simpleapi::counter_metric_t pkt_network_credentials_out
  95. { packets.Add({{"packet_type", "network_credentials"}, {"direction", "tx"}}) };
  96. prometheus::simpleapi::counter_metric_t pkt_network_config_request_out
  97. { packets.Add({{"packet_type", "network_config_request"}, {"direction", "tx"}}) };
  98. prometheus::simpleapi::counter_metric_t pkt_network_config_out
  99. { packets.Add({{"packet_type", "network_config"}, {"direction", "tx"}}) };
  100. prometheus::simpleapi::counter_metric_t pkt_multicast_gather_out
  101. { packets.Add({{"packet_type", "multicast_gather"}, {"direction", "tx"}}) };
  102. prometheus::simpleapi::counter_metric_t pkt_multicast_frame_out
  103. { packets.Add({{"packet_type", "multicast_frame"}, {"direction", "tx"}}) };
  104. prometheus::simpleapi::counter_metric_t pkt_push_direct_paths_out
  105. { packets.Add({{"packet_type", "push_direct_paths"}, {"direction", "tx"}}) };
  106. prometheus::simpleapi::counter_metric_t pkt_user_message_out
  107. { packets.Add({{"packet_type", "user_message"}, {"direction", "tx"}}) };
  108. prometheus::simpleapi::counter_metric_t pkt_remote_trace_out
  109. { packets.Add({{"packet_type", "remote_trace"}, {"direction", "tx"}}) };
  110. prometheus::simpleapi::counter_metric_t pkt_path_negotiation_request_out
  111. { packets.Add({{"packet_type", "path_negotiation_request"}, {"direction", "tx"}}) };
  112. // Packet Error Counts
  113. prometheus::simpleapi::counter_family_t packet_errors
  114. { "zt_packet_error", "ZeroTier packet errors"};
  115. // Incoming Error Counts
  116. prometheus::simpleapi::counter_metric_t pkt_error_obj_not_found_in
  117. { packet_errors.Add({{"error_type", "obj_not_found"}, {"direction", "rx"}}) };
  118. prometheus::simpleapi::counter_metric_t pkt_error_unsupported_op_in
  119. { packet_errors.Add({{"error_type", "unsupported_operation"}, {"direction", "rx"}}) };
  120. prometheus::simpleapi::counter_metric_t pkt_error_identity_collision_in
  121. { packet_errors.Add({{"error_type", "identity_collision"}, {"direction", "rx"}}) };
  122. prometheus::simpleapi::counter_metric_t pkt_error_need_membership_cert_in
  123. { packet_errors.Add({{"error_type", "need_membership_certificate"}, {"direction", "rx"}}) };
  124. prometheus::simpleapi::counter_metric_t pkt_error_network_access_denied_in
  125. { packet_errors.Add({{"error_type", "network_access_denied"}, {"direction", "rx"}}) };
  126. prometheus::simpleapi::counter_metric_t pkt_error_unwanted_multicast_in
  127. { packet_errors.Add({{"error_type", "unwanted_multicast"}, {"direction", "rx"}}) };
  128. prometheus::simpleapi::counter_metric_t pkt_error_authentication_required_in
  129. { packet_errors.Add({{"error_type", "authentication_required"}, {"direction", "rx"}}) };
  130. prometheus::simpleapi::counter_metric_t pkt_error_internal_server_error_in
  131. { packet_errors.Add({{"error_type", "internal_server_error"}, {"direction", "rx"}}) };
  132. // Outgoing Error Counts
  133. prometheus::simpleapi::counter_metric_t pkt_error_obj_not_found_out
  134. { packet_errors.Add({{"error_type", "obj_not_found"}, {"direction", "tx"}}) };
  135. prometheus::simpleapi::counter_metric_t pkt_error_unsupported_op_out
  136. { packet_errors.Add({{"error_type", "unsupported_operation"}, {"direction", "tx"}}) };
  137. prometheus::simpleapi::counter_metric_t pkt_error_identity_collision_out
  138. { packet_errors.Add({{"error_type", "identity_collision"}, {"direction", "tx"}}) };
  139. prometheus::simpleapi::counter_metric_t pkt_error_need_membership_cert_out
  140. { packet_errors.Add({{"error_type", "need_membership_certificate"}, {"direction", "tx"}}) };
  141. prometheus::simpleapi::counter_metric_t pkt_error_network_access_denied_out
  142. { packet_errors.Add({{"error_type", "network_access_denied"}, {"direction", "tx"}}) };
  143. prometheus::simpleapi::counter_metric_t pkt_error_unwanted_multicast_out
  144. { packet_errors.Add({{"error_type", "unwanted_multicast"}, {"direction", "tx"}}) };
  145. prometheus::simpleapi::counter_metric_t pkt_error_authentication_required_out
  146. { packet_errors.Add({{"error_type", "authentication_required"}, {"direction", "tx"}}) };
  147. prometheus::simpleapi::counter_metric_t pkt_error_internal_server_error_out
  148. { packet_errors.Add({{"error_type", "internal_server_error"}, {"direction", "tx"}}) };
  149. // Data Sent/Received Metrics
  150. prometheus::simpleapi::counter_family_t data
  151. { "zt_data", "number of bytes ZeroTier has transmitted or received" };
  152. prometheus::simpleapi::counter_metric_t udp_recv
  153. { data.Add({{"protocol","udp"},{"direction","rx"}}) };
  154. prometheus::simpleapi::counter_metric_t udp_send
  155. { data.Add({{"protocol","udp"},{"direction","tx"}}) };
  156. prometheus::simpleapi::counter_metric_t tcp_send
  157. { data.Add({{"protocol","tcp"},{"direction", "tx"}}) };
  158. prometheus::simpleapi::counter_metric_t tcp_recv
  159. { data.Add({{"protocol","tcp"},{"direction", "rx"}}) };
  160. // Network Metrics
  161. prometheus::simpleapi::gauge_metric_t network_num_joined
  162. { "zt_num_networks", "number of networks this instance is joined to" };
  163. prometheus::simpleapi::gauge_family_t network_num_multicast_groups
  164. { "zt_network_multicast_groups_subscribed", "number of multicast groups networks are subscribed to" };
  165. prometheus::simpleapi::counter_family_t network_packets
  166. { "zt_network_packets", "number of incoming/outgoing packets per network" };
  167. #ifndef ZT_NO_PEER_METRICS
  168. // PeerMetrics
  169. prometheus::CustomFamily<prometheus::Histogram<uint64_t>> &peer_latency =
  170. prometheus::Builder<prometheus::Histogram<uint64_t>>()
  171. .Name("zt_peer_latency")
  172. .Help("peer latency (ms)")
  173. .Register(prometheus::simpleapi::registry);
  174. prometheus::simpleapi::gauge_family_t peer_path_count
  175. { "zt_peer_path_count", "number of paths to peer" };
  176. prometheus::simpleapi::counter_family_t peer_packets
  177. { "zt_peer_packets", "number of packets to/from a peer" };
  178. prometheus::simpleapi::counter_family_t peer_packet_errors
  179. { "zt_peer_packet_errors" , "number of incoming packet errors from a peer" };
  180. #endif
  181. // General Controller Metrics
  182. prometheus::simpleapi::gauge_metric_t network_count
  183. {"controller_network_count", "number of networks the controller is serving"};
  184. prometheus::simpleapi::gauge_metric_t member_count
  185. {"controller_member_count", "number of network members the controller is serving"};
  186. prometheus::simpleapi::counter_metric_t network_changes
  187. {"controller_network_change_count", "number of times a network configuration is changed"};
  188. prometheus::simpleapi::counter_metric_t member_changes
  189. {"controller_member_change_count", "number of times a network member configuration is changed"};
  190. prometheus::simpleapi::counter_metric_t member_auths
  191. {"controller_member_auth_count", "number of network member auths"};
  192. prometheus::simpleapi::counter_metric_t member_deauths
  193. {"controller_member_deauth_count", "number of network member deauths"};
  194. prometheus::simpleapi::gauge_metric_t network_config_request_queue_size
  195. { "controller_network_config_request_queue", "number of entries in the request queue for network configurations" };
  196. prometheus::simpleapi::counter_metric_t sso_expiration_checks
  197. { "controller_sso_expiration_checks", "number of sso expiration checks done" };
  198. prometheus::simpleapi::counter_metric_t sso_member_deauth
  199. { "controller_sso_timeouts", "number of sso timeouts" };
  200. prometheus::simpleapi::counter_metric_t network_config_request
  201. { "controller_network_config_request", "count of config requests handled" };
  202. prometheus::simpleapi::gauge_metric_t network_config_request_threads
  203. { "controller_network_config_request_threads", "number of active network config handling threads" };
  204. prometheus::simpleapi::counter_metric_t db_get_network
  205. { "controller_db_get_network", "counter" };
  206. prometheus::simpleapi::counter_metric_t db_get_network_and_member
  207. { "controller_db_get_network_and_member", "counter" };
  208. prometheus::simpleapi::counter_metric_t db_get_network_and_member_and_summary
  209. { "controller_db_get_networK_and_member_summary", "counter" };
  210. prometheus::simpleapi::counter_metric_t db_get_member_list
  211. { "controller_db_get_member_list", "counter" };
  212. prometheus::simpleapi::counter_metric_t db_get_network_list
  213. { "controller_db_get_network_list", "counter" };
  214. prometheus::simpleapi::counter_metric_t db_member_change
  215. { "controller_db_member_change", "counter" };
  216. prometheus::simpleapi::counter_metric_t db_network_change
  217. { "controller_db_network_change", "counter" };
  218. #ifdef ZT_CONTROLLER_USE_LIBPQ
  219. // Central Controller Metrics
  220. prometheus::simpleapi::counter_metric_t pgsql_mem_notification
  221. { "controller_pgsql_member_notifications_received", "number of member change notifications received via pgsql NOTIFY" };
  222. prometheus::simpleapi::counter_metric_t pgsql_net_notification
  223. { "controller_pgsql_network_notifications_received", "number of network change notifications received via pgsql NOTIFY" };
  224. prometheus::simpleapi::counter_metric_t pgsql_node_checkin
  225. { "controller_pgsql_node_checkin_count", "number of node check-ins (pgsql)" };
  226. prometheus::simpleapi::counter_metric_t pgsql_commit_ticks
  227. { "controller_pgsql_commit_ticks", "number of commit ticks run (pgsql)" };
  228. prometheus::simpleapi::counter_metric_t db_get_sso_info
  229. { "controller_db_get_sso_info", "counter" };
  230. prometheus::simpleapi::counter_metric_t redis_mem_notification
  231. { "controller_redis_member_notifications_received", "number of member change notifications received via redis" };
  232. prometheus::simpleapi::counter_metric_t redis_net_notification
  233. { "controller_redis_network_notifications_received", "number of network change notifications received via redis" };
  234. prometheus::simpleapi::counter_metric_t redis_node_checkin
  235. { "controller_redis_node_checkin_count", "number of node check-ins (redis)" };
  236. // Central DB Pool Metrics
  237. prometheus::simpleapi::counter_metric_t conn_counter
  238. { "controller_pgsql_connections_created", "number of pgsql connections created"};
  239. prometheus::simpleapi::counter_metric_t max_pool_size
  240. { "controller_pgsql_max_conn_pool_size", "max connection pool size for postgres"};
  241. prometheus::simpleapi::counter_metric_t min_pool_size
  242. { "controller_pgsql_min_conn_pool_size", "minimum connection pool size for postgres" };
  243. prometheus::simpleapi::gauge_metric_t pool_avail
  244. { "controller_pgsql_available_conns", "number of available postgres connections" };
  245. prometheus::simpleapi::gauge_metric_t pool_in_use
  246. { "controller_pgsql_in_use_conns", "number of postgres database connections in use" };
  247. prometheus::simpleapi::counter_metric_t pool_errors
  248. { "controller_pgsql_connection_errors", "number of connection errors the connection pool has seen" };
  249. #endif
  250. }
  251. }