src/collecty/plugins/latency.py

   1 #!/usr/bin/python
   2 ###############################################################################
   3 #                                                                             #
   4 # collecty - A system statistics collection daemon for IPFire                 #
   5 # Copyright (C) 2012 IPFire development team                                  #
   6 #                                                                             #
   7 # This program is free software: you can redistribute it and/or modify        #
   8 # it under the terms of the GNU General Public License as published by        #
   9 # the Free Software Foundation, either version 3 of the License, or           #
  10 # (at your option) any later version.                                         #
  11 #                                                                             #
  12 # This program is distributed in the hope that it will be useful,             #
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of              #
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               #
  15 # GNU General Public License for more details.                                #
  16 #                                                                             #
  17 # You should have received a copy of the GNU General Public License           #
  18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.       #
  19 #                                                                             #
  20 ###############################################################################
  21
  22 import collecty.ping
  23
  24 import base
  25
  26 from ..i18n import _
  27
  28 PING_HOSTS = [
  29         "ping.ipfire.org",
  30 ]
  31
  32 class GraphTemplateLatency(base.GraphTemplate):
  33         name = "latency"
  34
  35         @property
  36         def rrd_graph(self):
  37                 return [
  38                         "DEF:latency=%(file)s:latency:AVERAGE",
  39                         "DEF:latency_loss=%(file)s:latency_loss:AVERAGE",
  40                         "DEF:latency_stddev=%(file)s:latency_stddev:AVERAGE",
  41
  42                         # Compute loss in percentage.
  43                         "CDEF:latency_ploss=latency_loss,100,*",
  44
  45                         # Compute standard deviation.
  46                         "CDEF:stddev1=latency,latency_stddev,+",
  47                         "CDEF:stddev2=latency,latency_stddev,-",
  48
  49                         "CDEF:l005=latency_ploss,0,5,LIMIT,UN,UNKN,INF,IF",
  50                         "CDEF:l010=latency_ploss,5,10,LIMIT,UN,UNKN,INF,IF",
  51                         "CDEF:l025=latency_ploss,10,25,LIMIT,UN,UNKN,INF,IF",
  52                         "CDEF:l050=latency_ploss,25,50,LIMIT,UN,UNKN,INF,IF",
  53                         "CDEF:l100=latency_ploss,50,100,LIMIT,UN,UNKN,INF,IF",
  54
  55                         "AREA:l005#ffffff:%s" % _("0-5%%"),
  56                         "AREA:l010#000000:%s" % _("5-10%%"),
  57                         "AREA:l025#ff0000:%s" % _("10-25%%"),
  58                         "AREA:l050#00ff00:%s" % _("25-50%%"),
  59                         "AREA:l100#0000ff:%s" % _("50-100%%") + "\\n",
  60
  61                         "LINE1:stddev1#00660088",
  62                         "LINE1:stddev2#00660088",
  63
  64                         "LINE3:latency#ff0000:%s" % _("Latency"),
  65                         "VDEF:latencymin=latency,MINIMUM",
  66                         "VDEF:latencymax=latency,MAXIMUM",
  67                         "VDEF:latencyavg=latency,AVERAGE",
  68                         "GPRINT:latencymax:%12s\:" % _("Maximum") + " %6.2lf",
  69                         "GPRINT:latencymin:%12s\:" % _("Minimum") + " %6.2lf",
  70                         "GPRINT:latencyavg:%12s\:" % _("Average") + " %6.2lf\\n",
  71
  72                         "LINE1:latencyavg#000000:%s" % _("Average latency"),
  73                 ]
  74
  75         @property
  76         def rrd_graph_args(self):
  77                 return [
  78                         "--title", _("Latency to %(host)s"),
  79                         "--vertical-label", _("Milliseconds"),
  80
  81                         "--lower-limit", "0", "--rigid",
  82                 ]
  83
  84
  85 class LatencyPlugin(base.Plugin):
  86         name = "latency"
  87         description = "Latency (ICMP ping) Data Source"
  88
  89         templates = [GraphTemplateLatency,]
  90
  91         rrd_schema = [
  92                 "DS:latency:GAUGE:0:U",
  93                 "DS:latency_loss:GAUGE:0:100",
  94                 "DS:latency_stddev:GAUGE:0:U",
  95         ]
  96
  97         @property
  98         def id(self):
  99                 return "-".join((self.name, self.host))
 100
 101         @classmethod
 102         def autocreate(cls, collecty, **kwargs):
 103                 ret = []
 104                 for host in PING_HOSTS:
 105                         ds = cls(collecty, host=host, **kwargs)
 106                         ret.append(ds)
 107
 108                 return ret
 109
 110         def init(self, **kwargs):
 111                 self.host = kwargs.get("host")
 112                 assert self.host
 113
 114         @property
 115         def deadline(self):
 116                 return self.interval - 10
 117
 118         def read(self):
 119                 # Send up to five ICMP echo requests.
 120                 try:
 121                         ping = collecty.ping.Ping(destination=self.host, timeout=20000)
 122                         ping.run(count=5, deadline=self.deadline)
 123
 124                 except collecty.ping.PingError, e:
 125                         self.log.warning(_("Could not run latency check for %(host)s: %(msg)s") \
 126                                 % { "host" : self.host, "msg" : e.msg })
 127                         return
 128
 129                 return ":".join((
 130                         "%.10f" % ping.avg_time,
 131                         "%.10f" % ping.loss,
 132                         "%.10f" % ping.stddev,
 133                 ))