opensips.chart.sh 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324
  1. # shellcheck shell=bash disable=SC1117,SC2154,SC2086
  2. # no need for shebang - this file is loaded from charts.d.plugin
  3. # SPDX-License-Identifier: GPL-3.0-or-later
  4. # netdata
  5. # real-time performance and health monitoring, done right!
  6. # (C) 2016 Costa Tsaousis <costa@tsaousis.gr>
  7. #
  8. opensips_opts="fifo get_statistics all"
  9. opensips_cmd=
  10. opensips_update_every=5
  11. opensips_timeout=2
  12. opensips_priority=80000
  13. opensips_get_stats() {
  14. run -t $opensips_timeout "$opensips_cmd" $opensips_opts |
  15. grep "^\(core\|dialog\|net\|registrar\|shmem\|siptrace\|sl\|tm\|uri\|usrloc\):[a-zA-Z0-9_-]\+[[:space:]]*[=:]\+[[:space:]]*[0-9]\+[[:space:]]*$" |
  16. sed \
  17. -e "s|[[:space:]]*[=:]\+[[:space:]]*\([0-9]\+\)[[:space:]]*$|=\1|g" \
  18. -e "s|[[:space:]:-]\+|_|g" \
  19. -e "s|^|opensips_|g"
  20. local ret=$?
  21. [ $ret -ne 0 ] && echo "opensips_command_failed=1"
  22. return $ret
  23. }
  24. opensips_check() {
  25. # if the user did not provide an opensips_cmd
  26. # try to find it in the system
  27. if [ -z "$opensips_cmd" ]; then
  28. require_cmd opensipsctl || return 1
  29. fi
  30. # check once if the command works
  31. local x
  32. x="$(opensips_get_stats | grep "^opensips_core_")"
  33. # shellcheck disable=SC2181
  34. if [ ! $? -eq 0 ] || [ -z "$x" ]; then
  35. error "cannot get global status. Please set opensips_opts='options' whatever needed to get connected to opensips server, in $confd/opensips.conf"
  36. return 1
  37. fi
  38. return 0
  39. }
  40. opensips_create() {
  41. # create the charts
  42. cat <<EOF
  43. CHART opensips.dialogs_active '' "OpenSIPS Active Dialogs" "dialogs" dialogs '' area $((opensips_priority + 1)) $opensips_update_every
  44. DIMENSION dialog_active_dialogs active absolute 1 1
  45. DIMENSION dialog_early_dialogs early absolute -1 1
  46. CHART opensips.users '' "OpenSIPS Users" "users" users '' line $((opensips_priority + 2)) $opensips_update_every
  47. DIMENSION usrloc_registered_users registered absolute 1 1
  48. DIMENSION usrloc_location_users location absolute 1 1
  49. DIMENSION usrloc_location_contacts contacts absolute 1 1
  50. DIMENSION usrloc_location_expires expires incremental -1 1
  51. CHART opensips.registrar '' "OpenSIPS Registrar" "registrations/s" registrar '' line $((opensips_priority + 3)) $opensips_update_every
  52. DIMENSION registrar_accepted_regs accepted incremental 1 1
  53. DIMENSION registrar_rejected_regs rejected incremental -1 1
  54. CHART opensips.transactions '' "OpenSIPS Transactions" "transactions/s" transactions '' line $((opensips_priority + 4)) $opensips_update_every
  55. DIMENSION tm_UAS_transactions UAS incremental 1 1
  56. DIMENSION tm_UAC_transactions UAC incremental -1 1
  57. CHART opensips.core_rcv '' "OpenSIPS Core Receives" "queries/s" core '' line $((opensips_priority + 5)) $opensips_update_every
  58. DIMENSION core_rcv_requests requests incremental 1 1
  59. DIMENSION core_rcv_replies replies incremental -1 1
  60. CHART opensips.core_fwd '' "OpenSIPS Core Forwards" "queries/s" core '' line $((opensips_priority + 6)) $opensips_update_every
  61. DIMENSION core_fwd_requests requests incremental 1 1
  62. DIMENSION core_fwd_replies replies incremental -1 1
  63. CHART opensips.core_drop '' "OpenSIPS Core Drops" "queries/s" core '' line $((opensips_priority + 7)) $opensips_update_every
  64. DIMENSION core_drop_requests requests incremental 1 1
  65. DIMENSION core_drop_replies replies incremental -1 1
  66. CHART opensips.core_err '' "OpenSIPS Core Errors" "queries/s" core '' line $((opensips_priority + 8)) $opensips_update_every
  67. DIMENSION core_err_requests requests incremental 1 1
  68. DIMENSION core_err_replies replies incremental -1 1
  69. CHART opensips.core_bad '' "OpenSIPS Core Bad" "queries/s" core '' line $((opensips_priority + 9)) $opensips_update_every
  70. DIMENSION core_bad_URIs_rcvd bad_URIs_rcvd incremental 1 1
  71. DIMENSION core_unsupported_methods unsupported_methods incremental 1 1
  72. DIMENSION core_bad_msg_hdr bad_msg_hdr incremental 1 1
  73. CHART opensips.tm_replies '' "OpenSIPS TM Replies" "replies/s" transactions '' line $((opensips_priority + 10)) $opensips_update_every
  74. DIMENSION tm_received_replies received incremental 1 1
  75. DIMENSION tm_relayed_replies relayed incremental 1 1
  76. DIMENSION tm_local_replies local incremental 1 1
  77. CHART opensips.transactions_status '' "OpenSIPS Transactions Status" "transactions/s" transactions '' line $((opensips_priority + 11)) $opensips_update_every
  78. DIMENSION tm_2xx_transactions 2xx incremental 1 1
  79. DIMENSION tm_3xx_transactions 3xx incremental 1 1
  80. DIMENSION tm_4xx_transactions 4xx incremental 1 1
  81. DIMENSION tm_5xx_transactions 5xx incremental 1 1
  82. DIMENSION tm_6xx_transactions 6xx incremental 1 1
  83. CHART opensips.transactions_inuse '' "OpenSIPS InUse Transactions" "transactions" transactions '' line $((opensips_priority + 12)) $opensips_update_every
  84. DIMENSION tm_inuse_transactions inuse absolute 1 1
  85. CHART opensips.sl_replies '' "OpenSIPS SL Replies" "replies/s" core '' line $((opensips_priority + 13)) $opensips_update_every
  86. DIMENSION sl_1xx_replies 1xx incremental 1 1
  87. DIMENSION sl_2xx_replies 2xx incremental 1 1
  88. DIMENSION sl_3xx_replies 3xx incremental 1 1
  89. DIMENSION sl_4xx_replies 4xx incremental 1 1
  90. DIMENSION sl_5xx_replies 5xx incremental 1 1
  91. DIMENSION sl_6xx_replies 6xx incremental 1 1
  92. DIMENSION sl_sent_replies sent incremental 1 1
  93. DIMENSION sl_sent_err_replies error incremental 1 1
  94. DIMENSION sl_received_ACKs ACKed incremental 1 1
  95. CHART opensips.dialogs '' "OpenSIPS Dialogs" "dialogs/s" dialogs '' line $((opensips_priority + 14)) $opensips_update_every
  96. DIMENSION dialog_processed_dialogs processed incremental 1 1
  97. DIMENSION dialog_expired_dialogs expired incremental 1 1
  98. DIMENSION dialog_failed_dialogs failed incremental -1 1
  99. CHART opensips.net_waiting '' "OpenSIPS Network Waiting" "kilobytes" net '' line $((opensips_priority + 15)) $opensips_update_every
  100. DIMENSION net_waiting_udp UDP absolute 1 1024
  101. DIMENSION net_waiting_tcp TCP absolute 1 1024
  102. CHART opensips.uri_checks '' "OpenSIPS URI Checks" "checks / sec" uri '' line $((opensips_priority + 16)) $opensips_update_every
  103. DIMENSION uri_positive_checks positive incremental 1 1
  104. DIMENSION uri_negative_checks negative incremental -1 1
  105. CHART opensips.traces '' "OpenSIPS Traces" "traces / sec" traces '' line $((opensips_priority + 17)) $opensips_update_every
  106. DIMENSION siptrace_traced_requests requests incremental 1 1
  107. DIMENSION siptrace_traced_replies replies incremental -1 1
  108. CHART opensips.shmem '' "OpenSIPS Shared Memory" "kilobytes" mem '' line $((opensips_priority + 18)) $opensips_update_every
  109. DIMENSION shmem_total_size total absolute 1 1024
  110. DIMENSION shmem_used_size used absolute 1 1024
  111. DIMENSION shmem_real_used_size real_used absolute 1 1024
  112. DIMENSION shmem_max_used_size max_used absolute 1 1024
  113. DIMENSION shmem_free_size free absolute 1 1024
  114. CHART opensips.shmem_fragments '' "OpenSIPS Shared Memory Fragmentation" "fragments" mem '' line $((opensips_priority + 19)) $opensips_update_every
  115. DIMENSION shmem_fragments fragments absolute 1 1
  116. EOF
  117. return 0
  118. }
  119. opensips_update() {
  120. # the first argument to this function is the microseconds since last update
  121. # pass this parameter to the BEGIN statement (see bellow).
  122. # do all the work to collect / calculate the values
  123. # for each dimension
  124. # 1. get the counters page from opensips
  125. # 2. sed to remove spaces; replace . with _; remove spaces around =; prepend each line with: local opensips_
  126. # 3. egrep lines starting with:
  127. # local opensips_client_http_ then one or more of these a-z 0-9 _ then = and one of more of 0-9
  128. # local opensips_server_all_ then one or more of these a-z 0-9 _ then = and one of more of 0-9
  129. # 4. then execute this as a script with the eval
  130. # be very carefull with eval:
  131. # prepare the script and always grep at the end the lines that are usefull, so that
  132. # even if something goes wrong, no other code can be executed
  133. unset \
  134. opensips_dialog_active_dialogs \
  135. opensips_dialog_early_dialogs \
  136. opensips_usrloc_registered_users \
  137. opensips_usrloc_location_users \
  138. opensips_usrloc_location_contacts \
  139. opensips_usrloc_location_expires \
  140. opensips_registrar_accepted_regs \
  141. opensips_registrar_rejected_regs \
  142. opensips_tm_UAS_transactions \
  143. opensips_tm_UAC_transactions \
  144. opensips_core_rcv_requests \
  145. opensips_core_rcv_replies \
  146. opensips_core_fwd_requests \
  147. opensips_core_fwd_replies \
  148. opensips_core_drop_requests \
  149. opensips_core_drop_replies \
  150. opensips_core_err_requests \
  151. opensips_core_err_replies \
  152. opensips_core_bad_URIs_rcvd \
  153. opensips_core_unsupported_methods \
  154. opensips_core_bad_msg_hdr \
  155. opensips_tm_received_replies \
  156. opensips_tm_relayed_replies \
  157. opensips_tm_local_replies \
  158. opensips_tm_2xx_transactions \
  159. opensips_tm_3xx_transactions \
  160. opensips_tm_4xx_transactions \
  161. opensips_tm_5xx_transactions \
  162. opensips_tm_6xx_transactions \
  163. opensips_tm_inuse_transactions \
  164. opensips_sl_1xx_replies \
  165. opensips_sl_2xx_replies \
  166. opensips_sl_3xx_replies \
  167. opensips_sl_4xx_replies \
  168. opensips_sl_5xx_replies \
  169. opensips_sl_6xx_replies \
  170. opensips_sl_sent_replies \
  171. opensips_sl_sent_err_replies \
  172. opensips_sl_received_ACKs \
  173. opensips_dialog_processed_dialogs \
  174. opensips_dialog_expired_dialogs \
  175. opensips_dialog_failed_dialogs \
  176. opensips_net_waiting_udp \
  177. opensips_net_waiting_tcp \
  178. opensips_uri_positive_checks \
  179. opensips_uri_negative_checks \
  180. opensips_siptrace_traced_requests \
  181. opensips_siptrace_traced_replies \
  182. opensips_shmem_total_size \
  183. opensips_shmem_used_size \
  184. opensips_shmem_real_used_size \
  185. opensips_shmem_max_used_size \
  186. opensips_shmem_free_size \
  187. opensips_shmem_fragments
  188. opensips_command_failed=0
  189. eval "local $(opensips_get_stats)"
  190. # shellcheck disable=SC2181
  191. [ $? -ne 0 ] && return 1
  192. [ $opensips_command_failed -eq 1 ] && error "failed to get values, disabling." && return 1
  193. # write the result of the work.
  194. cat <<VALUESEOF
  195. BEGIN opensips.dialogs_active $1
  196. SET dialog_active_dialogs = $opensips_dialog_active_dialogs
  197. SET dialog_early_dialogs = $opensips_dialog_early_dialogs
  198. END
  199. BEGIN opensips.users $1
  200. SET usrloc_registered_users = $opensips_usrloc_registered_users
  201. SET usrloc_location_users = $opensips_usrloc_location_users
  202. SET usrloc_location_contacts = $opensips_usrloc_location_contacts
  203. SET usrloc_location_expires = $opensips_usrloc_location_expires
  204. END
  205. BEGIN opensips.registrar $1
  206. SET registrar_accepted_regs = $opensips_registrar_accepted_regs
  207. SET registrar_rejected_regs = $opensips_registrar_rejected_regs
  208. END
  209. BEGIN opensips.transactions $1
  210. SET tm_UAS_transactions = $opensips_tm_UAS_transactions
  211. SET tm_UAC_transactions = $opensips_tm_UAC_transactions
  212. END
  213. BEGIN opensips.core_rcv $1
  214. SET core_rcv_requests = $opensips_core_rcv_requests
  215. SET core_rcv_replies = $opensips_core_rcv_replies
  216. END
  217. BEGIN opensips.core_fwd $1
  218. SET core_fwd_requests = $opensips_core_fwd_requests
  219. SET core_fwd_replies = $opensips_core_fwd_replies
  220. END
  221. BEGIN opensips.core_drop $1
  222. SET core_drop_requests = $opensips_core_drop_requests
  223. SET core_drop_replies = $opensips_core_drop_replies
  224. END
  225. BEGIN opensips.core_err $1
  226. SET core_err_requests = $opensips_core_err_requests
  227. SET core_err_replies = $opensips_core_err_replies
  228. END
  229. BEGIN opensips.core_bad $1
  230. SET core_bad_URIs_rcvd = $opensips_core_bad_URIs_rcvd
  231. SET core_unsupported_methods = $opensips_core_unsupported_methods
  232. SET core_bad_msg_hdr = $opensips_core_bad_msg_hdr
  233. END
  234. BEGIN opensips.tm_replies $1
  235. SET tm_received_replies = $opensips_tm_received_replies
  236. SET tm_relayed_replies = $opensips_tm_relayed_replies
  237. SET tm_local_replies = $opensips_tm_local_replies
  238. END
  239. BEGIN opensips.transactions_status $1
  240. SET tm_2xx_transactions = $opensips_tm_2xx_transactions
  241. SET tm_3xx_transactions = $opensips_tm_3xx_transactions
  242. SET tm_4xx_transactions = $opensips_tm_4xx_transactions
  243. SET tm_5xx_transactions = $opensips_tm_5xx_transactions
  244. SET tm_6xx_transactions = $opensips_tm_6xx_transactions
  245. END
  246. BEGIN opensips.transactions_inuse $1
  247. SET tm_inuse_transactions = $opensips_tm_inuse_transactions
  248. END
  249. BEGIN opensips.sl_replies $1
  250. SET sl_1xx_replies = $opensips_sl_1xx_replies
  251. SET sl_2xx_replies = $opensips_sl_2xx_replies
  252. SET sl_3xx_replies = $opensips_sl_3xx_replies
  253. SET sl_4xx_replies = $opensips_sl_4xx_replies
  254. SET sl_5xx_replies = $opensips_sl_5xx_replies
  255. SET sl_6xx_replies = $opensips_sl_6xx_replies
  256. SET sl_sent_replies = $opensips_sl_sent_replies
  257. SET sl_sent_err_replies = $opensips_sl_sent_err_replies
  258. SET sl_received_ACKs = $opensips_sl_received_ACKs
  259. END
  260. BEGIN opensips.dialogs $1
  261. SET dialog_processed_dialogs = $opensips_dialog_processed_dialogs
  262. SET dialog_expired_dialogs = $opensips_dialog_expired_dialogs
  263. SET dialog_failed_dialogs = $opensips_dialog_failed_dialogs
  264. END
  265. BEGIN opensips.net_waiting $1
  266. SET net_waiting_udp = $opensips_net_waiting_udp
  267. SET net_waiting_tcp = $opensips_net_waiting_tcp
  268. END
  269. BEGIN opensips.uri_checks $1
  270. SET uri_positive_checks = $opensips_uri_positive_checks
  271. SET uri_negative_checks = $opensips_uri_negative_checks
  272. END
  273. BEGIN opensips.traces $1
  274. SET siptrace_traced_requests = $opensips_siptrace_traced_requests
  275. SET siptrace_traced_replies = $opensips_siptrace_traced_replies
  276. END
  277. BEGIN opensips.shmem $1
  278. SET shmem_total_size = $opensips_shmem_total_size
  279. SET shmem_used_size = $opensips_shmem_used_size
  280. SET shmem_real_used_size = $opensips_shmem_real_used_size
  281. SET shmem_max_used_size = $opensips_shmem_max_used_size
  282. SET shmem_free_size = $opensips_shmem_free_size
  283. END
  284. BEGIN opensips.shmem_fragments $1
  285. SET shmem_fragments = $opensips_shmem_fragments
  286. END
  287. VALUESEOF
  288. return 0
  289. }