charts.d/phpfpm.chart.sh

   1 #!/bin/bash
   2
   3 # if this chart is called X.chart.sh, then all functions and global variables
   4 # must start with X_
   5
   6 # first, you need open php-fpm status in php-fpm.conf
   7 # second, you need add status location in nginx.conf
   8 # you can see, https://easyengine.io/tutorials/php/fpm-status-page/
   9
  10 declare -A phpfpm_urls=()
  11 declare -A phpfpm_curl_opts=()
  12
  13 # _update_every is a special variable - it holds the number of seconds
  14 # between the calls of the _update() function
  15 phpfpm_update_every=
  16 phpfpm_priority=60000
  17
  18 declare -a phpfpm_response=()
  19 phpfpm_pool=""
  20 phpfpm_start_time=""
  21 phpfpm_start_since=0
  22 phpfpm_accepted_conn=0
  23 phpfpm_listen_queue=0
  24 phpfpm_max_listen_queue=0
  25 phpfpm_listen_queue_len=0
  26 phpfpm_idle_processes=0
  27 phpfpm_active_processes=0
  28 phpfpm_total_processes=0
  29 phpfpm_max_active_processes=0
  30 phpfpm_max_children_reached=0
  31 phpfpm_slow_requests=0
  32 phpfpm_get() {
  33         local opts="${1}" url="${2}"
  34
  35         phpfpm_response=($(curl -Ss ${opts} "${url}"))
  36         [ $? -ne 0 -o "${#phpfpm_response[@]}" -eq 0 ] && return 1
  37
  38         if [[ "${phpfpm_response[0]}" != "pool:" \
  39                 || "${phpfpm_response[2]}" != "process" \
  40                 || "${phpfpm_response[5]}" != "start" \
  41                 || "${phpfpm_response[12]}" != "accepted" \
  42                 || "${phpfpm_response[15]}" != "listen" \
  43                 || "${phpfpm_response[16]}" != "queue:" \
  44                 || "${phpfpm_response[26]}" != "idle" \
  45                 || "${phpfpm_response[29]}" != "active" \
  46                 || "${phpfpm_response[32]}" != "total" \
  47                 || "${phpfpm_response[43]}" != "slow" \
  48         ]]
  49                 then
  50                 echo >&2 "phpfpm: invalid response from phpfpm status server: ${phpfpm_response[*]}"
  51                 return 1
  52         fi
  53
  54         phpfpm_pool="${phpfpm_response[1]}"
  55         phpfpm_start_time="${phpfpm_response[7]} ${phpfpm_response[8]}"
  56         phpfpm_start_since="${phpfpm_response[11]}"
  57         phpfpm_accepted_conn="${phpfpm_response[14]}"
  58         phpfpm_listen_queue="${phpfpm_response[17]}"
  59         phpfpm_max_listen_queue="${phpfpm_response[21]}"
  60         phpfpm_listen_queue_len="${phpfpm_response[25]}"
  61         phpfpm_idle_processes="${phpfpm_response[28]}"
  62         phpfpm_active_processes="${phpfpm_response[31]}"
  63         phpfpm_total_processes="${phpfpm_response[34]}"
  64         phpfpm_max_active_processes="${phpfpm_response[38]}"
  65         phpfpm_max_children_reached="${phpfpm_response[42]}"
  66         phpfpm_slow_requests="${phpfpm_response[45]}"
  67
  68         if [[ -z "${phpfpm_pool}" \
  69                 || -z "${phpfpm_start_time}" \
  70                 || -z "${phpfpm_start_since}" \
  71                 || -z "${phpfpm_accepted_conn}" \
  72                 || -z "${phpfpm_listen_queue}" \
  73                 || -z "${phpfpm_max_listen_queue}" \
  74                 || -z "${phpfpm_listen_queue_len}" \
  75                 || -z "${phpfpm_idle_processes}" \
  76                 || -z "${phpfpm_active_processes}" \
  77                 || -z "${phpfpm_total_processes}" \
  78                 || -z "${phpfpm_max_active_processes}" \
  79                 || -z "${phpfpm_max_children_reached}" \
  80                 || -z "${phpfpm_slow_requests}" \
  81         ]]
  82                 then
  83                 echo >&2 "phpfpm: empty values got from phpfpm status server: ${phpfpm_response[*]}"
  84                 return 1
  85         fi
  86
  87         return 0
  88 }
  89
  90 # _check is called once, to find out if this chart should be enabled or not
  91 phpfpm_check() {
  92         if [ ${#phpfpm_urls[@]} -eq 0 ]; then
  93                 phpfpm_urls[local]="http://localhost/status"
  94         fi
  95
  96         local m
  97         for m in "${!phpfpm_urls[@]}"
  98         do
  99                 phpfpm_get "${phpfpm_curl_opts[$m]}" "${phpfpm_urls[$m]}"
 100                 if [ $? -ne 0 ]; then
 101                         echo >&2 "phpfpm: cannot find status on URL '${phpfpm_url[$m]}'. Please set phpfpm_urls[$m]='http://localhost/status' in $confd/phpfpm.conf"
 102                         unset phpfpm_urls[$m]
 103                         continue
 104                 fi
 105         done
 106
 107         if [ ${#phpfpm_urls[@]} -eq 0 ]; then
 108                 echo >&2 "phpfpm: no phpfpm servers found. Please set phpfpm_urls[name]='url' to whatever needed to get status to the phpfpm server, in $confd/phpfpm.conf"
 109                 return 1
 110         fi
 111
 112         # this should return:
 113         #  - 0 to enable the chart
 114         #  - 1 to disable the chart
 115
 116         return 0
 117 }
 118
 119 # _create is called once, to create the charts
 120 phpfpm_create() {
 121         local m
 122         for m in "${!phpfpm_urls[@]}"
 123         do
 124                 cat <<EOF
 125 CHART phpfpm_$m.connections '' "PHP-FPM Active Connections" "connections" phpfpm phpfpm.connections line $((phpfpm_priority + 1)) $phpfpm_update_every
 126 DIMENSION active '' absolute 1 1
 127 DIMENSION maxActive 'max active' absolute 1 1
 128 DIMENSION idle '' absolute 1 1
 129
 130 CHART phpfpm_$m.requests '' "PHP-FPM Requests" "requests/s" phpfpm phpfpm.requests line $((phpfpm_priority + 2)) $phpfpm_update_every
 131 DIMENSION requests '' incremental 1 1
 132
 133 CHART phpfpm_$m.performance '' "PHP-FPM Performance" "status" phpfpm phpfpm.performance line $((phpfpm_priority + 3)) $phpfpm_update_every
 134 DIMENSION reached 'max children reached' absolute 1 1
 135 DIMENSION slow 'slow requests' absolute 1 1
 136 EOF
 137         done
 138
 139         return 0
 140 }
 141
 142 # _update is called continiously, to collect the values
 143 phpfpm_update() {
 144         # the first argument to this function is the microseconds since last update
 145         # pass this parameter to the BEGIN statement (see bellow).
 146
 147         # do all the work to collect / calculate the values
 148         # for each dimension
 149         # remember: KEEP IT SIMPLE AND SHORT
 150
 151         local m
 152         for m in "${!phpfpm_urls[@]}"
 153         do
 154                 phpfpm_get "${phpfpm_curl_opts[$m]}" "${phpfpm_urls[$m]}"
 155                 if [ $? -ne 0 ]; then
 156                         continue
 157                 fi
 158
 159                 # write the result of the work.
 160                 cat <<EOF
 161 BEGIN phpfpm_$m.connections $1
 162 SET active = $((phpfpm_active_processes))
 163 SET maxActive = $((phpfpm_max_active_processes))
 164 SET idle = $((phpfpm_idle_processes))
 165 END
 166 BEGIN phpfpm_$m.requests $1
 167 SET requests = $((phpfpm_accepted_conn))
 168 END
 169 BEGIN phpfpm_$m.performance $1
 170 SET reached = $((phpfpm_max_children_reached))
 171 SET slow = $((phpfpm_slow_requests))
 172 END
 173 EOF
 174         done
 175
 176         return 0
 177 }