charts.d/squid.chart.sh

   1 #!/bin/sh
   2
   3 squid_host="127.0.0.1"
   4 squid_port="3127"
   5 squid_url="cache_object://$squid_host:$squid_port/counters"
   6 squid_update_every=5
   7
   8 squid_get_stats() {
   9 nc $squid_host $squid_port <<EOF
  10 GET $squid_url HTTP/1.0
  11
  12 EOF
  13 }
  14
  15 squid_check() {
  16         # check once if the url works
  17         local x=`squid_get_stats | grep client_http.requests`
  18         if [ ! $? -eq 0 -o -z "$x" ]
  19         then
  20                 echo >&2 "squid: 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"
  21                 return 1
  22         fi
  23
  24         return 0
  25 }
  26
  27 squid_create() {
  28         # create the charts
  29         cat <<EOF
  30 CHART squid.clients_net '' "Squid Client Bandwidth" "kilobits / $squid_update_every sec" squid '' area 20001 $squid_update_every
  31 DIMENSION client_http_kbytes_in in incremental 8 $((1 * squid_update_every))
  32 DIMENSION client_http_kbytes_out out incremental -8 $((1 * squid_update_every))
  33 DIMENSION client_http_hit_kbytes_out hits incremental -8 $((1 * squid_update_every))
  34
  35 CHART squid.clients_requests '' "Squid Client Requests" "requests / $squid_update_every sec" squid '' line 20003 $squid_update_every
  36 DIMENSION client_http_requests requests incremental 1 $((1 * squid_update_every))
  37 DIMENSION client_http_hits hits incremental 1 $((1 * squid_update_every))
  38 DIMENSION client_http_errors errors incremental -1 $((1 * squid_update_every))
  39
  40 CHART squid.servers_net '' "Squid Server Bandwidth" "kilobits / $squid_update_every sec" squid '' area 20002 $squid_update_every
  41 DIMENSION server_all_kbytes_in in incremental 8 $((1 * squid_update_every))
  42 DIMENSION server_all_kbytes_out out incremental -8 $((1 * squid_update_every))
  43
  44 CHART squid.servers_requests '' "Squid Server Requests" "requests / $squid_update_every sec" squid '' line 20004 $squid_update_every
  45 DIMENSION server_all_requests requests incremental 1 $((1 * squid_update_every))
  46 DIMENSION server_all_errors errors incremental -1 $((1 * squid_update_every))
  47 EOF
  48
  49         return 0
  50 }
  51
  52
  53 squid_update() {
  54         # the first argument to this function is the microseconds since last update
  55         # pass this parameter to the BEGIN statement (see bellow).
  56
  57         # do all the work to collect / calculate the values
  58         # for each dimension
  59         # remember: KEEP IT SIMPLE AND SHORT
  60
  61         # 1. wget the counters page from squid
  62         # 2. sed to remove spaces; replace . with _; remove spaces around =; prepend each line with: local squid_
  63         # 3. egrep lines starting with:
  64         #    local squid_client_http_ then one or more of these a-z 0-9 _ then = and one of more of 0-9
  65         #    local squid_server_all_ then one or more of these a-z 0-9 _ then = and one of more of 0-9
  66         # 4. then execute this as a script with the eval
  67         #
  68         # be very carefull with eval:
  69         # prepare the script and always grep at the end the lines that are usefull, so that
  70         # even if something goes wrong, no other code can be executed
  71
  72         eval "`squid_get_stats |\
  73                  sed -e "s/ \+/ /g" -e "s/\./_/g" -e "s/^\([a-z0-9_]\+\) *= *\([0-9]\+\)$/local squid_\1=\2/g" |\
  74                 egrep "^local squid_(client_http|server_all)_[a-z0-9_]+=[0-9]+$"`"
  75
  76         # write the result of the work.
  77         cat <<VALUESEOF
  78 BEGIN squid.clients_net $1
  79 SET client_http_kbytes_in = $squid_client_http_kbytes_in
  80 SET client_http_kbytes_out = $squid_client_http_kbytes_out
  81 SET client_http_hit_kbytes_out = $squid_client_http_hit_kbytes_out
  82 END
  83
  84 BEGIN squid.clients_requests $1
  85 SET client_http_requests = $squid_client_http_requests
  86 SET client_http_hits = $squid_client_http_hits
  87 SET client_http_errors = $squid_client_http_errors
  88 END
  89
  90 BEGIN squid.servers_net $1
  91 SET server_all_kbytes_in = $squid_server_all_kbytes_in
  92 SET server_all_kbytes_out = $squid_server_all_kbytes_out
  93 END
  94
  95 BEGIN squid.servers_requests $1
  96 SET server_all_requests = $squid_server_all_requests
  97 SET server_all_errors = $squid_server_all_errors
  98 END
  99 VALUESEOF
 100
 101         return 0
 102 }
 103