Migrate to Python 3
[collecty.git] / src / collecty / plugins / latency.py
1 #!/usr/bin/python3
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 from . 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         lower_limit = 0
36
37         @property
38         def rrd_graph(self):
39                 return [
40                         "DEF:latency=%(file)s:latency:AVERAGE",
41                         "DEF:latency_loss=%(file)s:latency_loss:AVERAGE",
42                         "DEF:latency_stddev=%(file)s:latency_stddev:AVERAGE",
43
44                         # Compute loss in percentage.
45                         "CDEF:latency_ploss=latency_loss,100,*",
46
47                         # Compute standard deviation.
48                         "CDEF:stddev1=latency,latency_stddev,+",
49                         "CDEF:stddev2=latency,latency_stddev,-",
50
51                         "CDEF:l005=latency_ploss,0,5,LIMIT,UN,UNKN,INF,IF",
52                         "CDEF:l010=latency_ploss,5,10,LIMIT,UN,UNKN,INF,IF",
53                         "CDEF:l025=latency_ploss,10,25,LIMIT,UN,UNKN,INF,IF",
54                         "CDEF:l050=latency_ploss,25,50,LIMIT,UN,UNKN,INF,IF",
55                         "CDEF:l100=latency_ploss,50,100,LIMIT,UN,UNKN,INF,IF",
56
57                         "AREA:l005#ffffff:%s" % _("0-5%%"),
58                         "AREA:l010#000000:%s" % _("5-10%%"),
59                         "AREA:l025#ff0000:%s" % _("10-25%%"),
60                         "AREA:l050#00ff00:%s" % _("25-50%%"),
61                         "AREA:l100#0000ff:%s" % _("50-100%%") + "\\n",
62
63                         "LINE1:stddev1#00660088",
64                         "LINE1:stddev2#00660088",
65
66                         "LINE3:latency#ff0000:%s" % _("Latency"),
67                         "VDEF:latencymin=latency,MINIMUM",
68                         "VDEF:latencymax=latency,MAXIMUM",
69                         "VDEF:latencyavg=latency,AVERAGE",
70                         "GPRINT:latencymax:%12s\:" % _("Maximum") + " %6.2lf",
71                         "GPRINT:latencymin:%12s\:" % _("Minimum") + " %6.2lf",
72                         "GPRINT:latencyavg:%12s\:" % _("Average") + " %6.2lf\\n",
73
74                         "LINE1:latencyavg#000000:%s" % _("Average latency"),
75                 ]
76
77         @property
78         def graph_title(self):
79                 return _("Latency to %(host)s")
80
81         @property
82         def graph_vertical_label(self):
83                 return _("Milliseconds")
84
85
86 class LatencyObject(base.Object):
87         rrd_schema = [
88                 "DS:latency:GAUGE:0:U",
89                 "DS:latency_loss:GAUGE:0:100",
90                 "DS:latency_stddev:GAUGE:0:U",
91         ]
92
93         def __repr__(self):
94                 return "<%s %s>" % (self.__class__.__name__, self.hostname)
95
96         def init(self, hostname, deadline=None):
97                 self.hostname = hostname
98                 self.deadline = deadline
99
100         @property
101         def id(self):
102                 return self.hostname
103
104         def collect(self):
105                 # Send up to five ICMP echo requests.
106                 try:
107                         ping = collecty.ping.Ping(destination=self.hostname, timeout=20000)
108                         ping.run(count=5, deadline=self.deadline)
109
110                 except collecty.ping.PingError as e:
111                         self.log.warning(_("Could not run latency check for %(host)s: %(msg)s") \
112                                 % { "host" : self.hostname, "msg" : e.msg })
113                         return
114
115                 return (
116                         "%.10f" % ping.avg_time,
117                         "%.10f" % ping.loss,
118                         "%.10f" % ping.stddev,
119                 )
120
121
122 class LatencyPlugin(base.Plugin):
123         name = "latency"
124         description = "Latency (ICMP ping) Plugin"
125
126         templates = [GraphTemplateLatency]
127
128         interval = 60
129
130         @property
131         def objects(self):
132                 deadline = self.interval / len(PING_HOSTS)
133
134                 for hostname in PING_HOSTS:
135                         yield LatencyObject(self, hostname, deadline=deadline)