charts.d/squid.chart.sh

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