Migrate to Python 3

[collecty.git] / src / collecty / plugins / latency.py

#!/usr/bin/python3
###############################################################################
#                                                                             #
# collecty - A system statistics collection daemon for IPFire                 #
# Copyright (C) 2012 IPFire development team                                  #
#                                                                             #
# This program is free software: you can redistribute it and/or modify        #
# it under the terms of the GNU General Public License as published by        #
# the Free Software Foundation, either version 3 of the License, or           #
# (at your option) any later version.                                         #
#                                                                             #
# This program is distributed in the hope that it will be useful,             #
# but WITHOUT ANY WARRANTY; without even the implied warranty of              #
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               #
# GNU General Public License for more details.                                #
#                                                                             #
# You should have received a copy of the GNU General Public License           #
# along with this program.  If not, see <http://www.gnu.org/licenses/>.       #
#                                                                             #
###############################################################################

import collecty.ping

from . import base

from ..i18n import _

PING_HOSTS = [
	"ping.ipfire.org",
]

class GraphTemplateLatency(base.GraphTemplate):
	name = "latency"

	lower_limit = 0

	@property
	def rrd_graph(self):
		return [
			"DEF:latency=%(file)s:latency:AVERAGE",
			"DEF:latency_loss=%(file)s:latency_loss:AVERAGE",
			"DEF:latency_stddev=%(file)s:latency_stddev:AVERAGE",

			# Compute loss in percentage.
			"CDEF:latency_ploss=latency_loss,100,*",

			# Compute standard deviation.
			"CDEF:stddev1=latency,latency_stddev,+",
			"CDEF:stddev2=latency,latency_stddev,-",

			"CDEF:l005=latency_ploss,0,5,LIMIT,UN,UNKN,INF,IF",
			"CDEF:l010=latency_ploss,5,10,LIMIT,UN,UNKN,INF,IF",
			"CDEF:l025=latency_ploss,10,25,LIMIT,UN,UNKN,INF,IF",
			"CDEF:l050=latency_ploss,25,50,LIMIT,UN,UNKN,INF,IF",
			"CDEF:l100=latency_ploss,50,100,LIMIT,UN,UNKN,INF,IF",

			"AREA:l005#ffffff:%s" % _("0-5%%"),
			"AREA:l010#000000:%s" % _("5-10%%"),
			"AREA:l025#ff0000:%s" % _("10-25%%"),
			"AREA:l050#00ff00:%s" % _("25-50%%"),
			"AREA:l100#0000ff:%s" % _("50-100%%") + "\\n",

			"LINE1:stddev1#00660088",
			"LINE1:stddev2#00660088",

			"LINE3:latency#ff0000:%s" % _("Latency"),
			"VDEF:latencymin=latency,MINIMUM",
			"VDEF:latencymax=latency,MAXIMUM",
			"VDEF:latencyavg=latency,AVERAGE",
			"GPRINT:latencymax:%12s\:" % _("Maximum") + " %6.2lf",
			"GPRINT:latencymin:%12s\:" % _("Minimum") + " %6.2lf",
			"GPRINT:latencyavg:%12s\:" % _("Average") + " %6.2lf\\n",

			"LINE1:latencyavg#000000:%s" % _("Average latency"),
		]

	@property
	def graph_title(self):
		return _("Latency to %(host)s")

	@property
	def graph_vertical_label(self):
		return _("Milliseconds")


class LatencyObject(base.Object):
	rrd_schema = [
		"DS:latency:GAUGE:0:U",
		"DS:latency_loss:GAUGE:0:100",
		"DS:latency_stddev:GAUGE:0:U",
	]

	def __repr__(self):
		return "<%s %s>" % (self.__class__.__name__, self.hostname)

	def init(self, hostname, deadline=None):
		self.hostname = hostname
		self.deadline = deadline

	@property
	def id(self):
		return self.hostname

	def collect(self):
		# Send up to five ICMP echo requests.
		try:
			ping = collecty.ping.Ping(destination=self.hostname, timeout=20000)
			ping.run(count=5, deadline=self.deadline)

		except collecty.ping.PingError as e:
			self.log.warning(_("Could not run latency check for %(host)s: %(msg)s") \
				% { "host" : self.hostname, "msg" : e.msg })
			return

		return (
			"%.10f" % ping.avg_time,
			"%.10f" % ping.loss,
			"%.10f" % ping.stddev,
		)


class LatencyPlugin(base.Plugin):
	name = "latency"
	description = "Latency (ICMP ping) Plugin"

	templates = [GraphTemplateLatency]

	interval = 60

	@property
	def objects(self):
		deadline = self.interval / len(PING_HOSTS)

		for hostname in PING_HOSTS:
			yield LatencyObject(self, hostname, deadline=deadline)