1 # no need for shebang - this file is loaded from charts.d.plugin
4 # real-time performance and health monitoring, done right!
5 # (C) 2016 Costa Tsaousis <costa@tsaousis.gr>
16 squid_get_stats_internal() {
17 local host="$1" port="$2" url="$3"
18 run squidclient -h $host -p $port $url
22 squid_get_stats_internal "$squid_host" "$squid_port" "$squid_url"
26 local host="127.0.0.1" port url x
30 for url in "cache_object://$host:$port/counters" "/squid-internal-mgr/counters"
32 x=$(squid_get_stats_internal "$host" "$port" "$url" | grep client_http.requests)
38 debug "found squid at '$host:$port' with url '$url'"
44 error "cannot find squid running in localhost. Please set squid_url='url' and squid_host='IP' and squid_port='PORT' in $confd/squid.conf"
49 require_cmd squidclient || return 1
50 require_cmd sed || return 1
51 require_cmd egrep || return 1
53 if [ -z "$squid_host" -o -z "$squid_port" -o -z "$squid_url" ]
55 squid_autodetect || return 1
58 # check once if the url works
59 local x="$(squid_get_stats | grep client_http.requests)"
60 if [ ! $? -eq 0 -o -z "$x" ]
62 error "cannot fetch URL '$squid_url' by connecting to $squid_host:$squid_port. Please set squid_url='url' and squid_host='host' and squid_port='port' in $confd/squid.conf"
72 CHART squid_local.clients_net '' "Squid Client Bandwidth" "kilobits / sec" clients squid.clients.net area $((squid_priority + 1)) $squid_update_every
73 DIMENSION client_http_kbytes_in in incremental 8 1
74 DIMENSION client_http_kbytes_out out incremental -8 1
75 DIMENSION client_http_hit_kbytes_out hits incremental -8 1
77 CHART squid_local.clients_requests '' "Squid Client Requests" "requests / sec" clients squid.clients.requests line $((squid_priority + 3)) $squid_update_every
78 DIMENSION client_http_requests requests incremental 1 1
79 DIMENSION client_http_hits hits incremental 1 1
80 DIMENSION client_http_errors errors incremental -1 1
82 CHART squid_local.servers_net '' "Squid Server Bandwidth" "kilobits / sec" servers squid.servers.net area $((squid_priority + 2)) $squid_update_every
83 DIMENSION server_all_kbytes_in in incremental 8 1
84 DIMENSION server_all_kbytes_out out incremental -8 1
86 CHART squid_local.servers_requests '' "Squid Server Requests" "requests / sec" servers squid.servers.requests line $((squid_priority + 4)) $squid_update_every
87 DIMENSION server_all_requests requests incremental 1 1
88 DIMENSION server_all_errors errors incremental -1 1
96 # the first argument to this function is the microseconds since last update
97 # pass this parameter to the BEGIN statement (see bellow).
99 # do all the work to collect / calculate the values
101 # remember: KEEP IT SIMPLE AND SHORT
103 # 1. get the counters page from squid
104 # 2. sed to remove spaces; replace . with _; remove spaces around =; prepend each line with: local squid_
105 # 3. egrep lines starting with:
106 # local squid_client_http_ then one or more of these a-z 0-9 _ then = and one of more of 0-9
107 # local squid_server_all_ then one or more of these a-z 0-9 _ then = and one of more of 0-9
108 # 4. then execute this as a script with the eval
110 # be very carefull with eval:
111 # prepare the script and always grep at the end the lines that are usefull, so that
112 # even if something goes wrong, no other code can be executed
114 eval "$(squid_get_stats |\
115 sed -e "s/ \+/ /g" -e "s/\./_/g" -e "s/^\([a-z0-9_]\+\) *= *\([0-9]\+\)$/local squid_\1=\2/g" |\
116 egrep "^local squid_(client_http|server_all)_[a-z0-9_]+=[0-9]+$")"
118 # write the result of the work.
120 BEGIN squid_local.clients_net $1
121 SET client_http_kbytes_in = $squid_client_http_kbytes_in
122 SET client_http_kbytes_out = $squid_client_http_kbytes_out
123 SET client_http_hit_kbytes_out = $squid_client_http_hit_kbytes_out
126 BEGIN squid_local.clients_requests $1
127 SET client_http_requests = $squid_client_http_requests
128 SET client_http_hits = $squid_client_http_hits
129 SET client_http_errors = $squid_client_http_errors
132 BEGIN squid_local.servers_net $1
133 SET server_all_kbytes_in = $squid_server_all_kbytes_in
134 SET server_all_kbytes_out = $squid_server_all_kbytes_out
137 BEGIN squid_local.servers_requests $1
138 SET server_all_requests = $squid_server_all_requests
139 SET server_all_errors = $squid_server_all_errors