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