df: Refactor graphs

[collecty.git] / src / collecty / plugins / df.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 os

from .. import _collecty
from . import base

from ..constants import *
from ..colours import *

class GraphTemplateDiskUsage(base.GraphTemplate):
	name = "disk-usage"
	lower_limit = 0

	@property
	def rrd_graph(self):
		_ = self.locale.translate

		return [
			"COMMENT:%s" % EMPTY_LABEL,
			"COMMENT:%s" % (COLUMN % _("Current")),
			"COMMENT:%s" % (COLUMN % _("Average")),
			"COMMENT:%s" % (COLUMN % _("Minimum")),
			"COMMENT:%s\\j" % (COLUMN % _("Maximum")),

			# Area for the used space
			"AREA:used%s:%s" % (
				transparency(LIGHT_RED, AREA_OPACITY),
				LABEL % _("Used"),
			),
			"GPRINT:used_cur:%s" % LARGE_FLOAT,
			"GPRINT:used_avg:%s" % LARGE_FLOAT,
			"GPRINT:used_min:%s" % LARGE_FLOAT,
			"GPRINT:used_max:%s\\j" % LARGE_FLOAT,

			# Stacked area of unused space
			"AREA:free%s:%s:STACK" % (
				transparency(LIGHT_GREEN, AREA_OPACITY),
				LABEL % _("Free"),
			),
			"GPRINT:free_cur:%s" % LARGE_FLOAT,
			"GPRINT:free_avg:%s" % LARGE_FLOAT,
			"GPRINT:free_min:%s" % LARGE_FLOAT,
			"GPRINT:free_max:%s\\j" % LARGE_FLOAT,

			# Add contour lines for the areas
			"LINE:used%s" % LIGHT_RED,
			"LINE:free%s::STACK" % LIGHT_GREEN,
		]

	@property
	def graph_title(self):
		_ = self.locale.translate
		return _("Disk Usage of %s") % self.object.mountpoint

	@property
	def graph_vertical_label(self):
		_ = self.locale.translate
		return _("Bytes")


class GraphTemplateInodeUsage(base.GraphTemplate):
	name = "inode-usage"
	lower_limit = 0

	@property
	def rrd_graph(self):
		_ = self.locale.translate

		rrd_graph = [
			"COMMENT:%s" % EMPTY_LABEL,
			"COMMENT:%s" % (COLUMN % _("Current")),
			"COMMENT:%s" % (COLUMN % _("Average")),
			"COMMENT:%s" % (COLUMN % _("Minimum")),
			"COMMENT:%s\\j" % (COLUMN % _("Maximum")),

			# Area for the used inodes
			"AREA:inodes_used%s:%s" % (
				transparency(LIGHT_RED, AREA_OPACITY),
				LABEL % _("Used"),
			),
			"GPRINT:inodes_used_cur:%s" % LARGE_FLOAT,
			"GPRINT:inodes_used_avg:%s" % LARGE_FLOAT,
			"GPRINT:inodes_used_min:%s" % LARGE_FLOAT,
			"GPRINT:inodes_used_max:%s\\j" % LARGE_FLOAT,

			# Stacked area of unused inodes
			"AREA:inodes_free%s:%s:STACK" % (
				transparency(LIGHT_GREEN, AREA_OPACITY),
				LABEL % _("Free"),
			),
			"GPRINT:inodes_free_cur:%s" % LARGE_FLOAT,
			"GPRINT:inodes_free_avg:%s" % LARGE_FLOAT,
			"GPRINT:inodes_free_min:%s" % LARGE_FLOAT,
			"GPRINT:inodes_free_max:%s\\j" % LARGE_FLOAT,

			# Add contour lines for the areas
			"LINE:inodes_used%s" % LIGHT_RED,
			"LINE:inodes_free%s::STACK" % LIGHT_GREEN,
		]

		return rrd_graph

	rrd_graph_args = [
		"--base", "1000", # inodes
	]

	@property
	def graph_title(self):
		_ = self.locale.translate
		return _("Inode Usage of %s") % self.object.mountpoint

	@property
	def graph_vertical_label(self):
		_ = self.locale.translate
		return _("Inodes")


class DiskUsageObject(base.Object):
	rrd_schema = [
		"DS:used:GAUGE:0:U",
		"DS:free:GAUGE:0:U",
		"DS:inodes_used:GAUGE:0:U",
		"DS:inodes_free:GAUGE:0:U",
	]

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

	def init(self, mountpoint):
		self.mountpoint = mountpoint

	@property
	def id(self):
		mountpoint = self.mountpoint

		if mountpoint.startswith("/"):
			mountpoint = mountpoint[1:]

		if not mountpoint:
			return "root"

		return mountpoint.replace("/", "-")

	def collect(self):
		stats = os.statvfs(self.mountpoint)

		return (
			# used
			(stats.f_blocks * stats.f_frsize) - \
				(stats.f_bfree * stats.f_bsize),
			# free
			stats.f_bfree * stats.f_bsize,
			# inodes used
			stats.f_files - stats.f_ffree,
			# inodes free
			stats.f_ffree,
		)


class DiskUsagePlugin(base.Plugin):
	name = "df"
	description = "Disk Usage Plugin"

	templates = [
		GraphTemplateDiskUsage,
		GraphTemplateInodeUsage,
	]

	@property
	def objects(self):
		for dev, mnt, fs, opts in _collecty.get_mountpoints():
			yield DiskUsageObject(self, mnt)