Migrate to Python 3
[collecty.git] / src / collecty / plugins / cpu.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
23
24 from . import base
25
26 from ..i18n import _
27
28 class GraphTemplateProcessor(base.GraphTemplate):
29         name = "processor"
30
31         rrd_graph = [
32                 "DEF:user=%(file)s:user:AVERAGE",
33                 "DEF:nice=%(file)s:nice:AVERAGE",
34                 "DEF:sys=%(file)s:sys:AVERAGE",
35                 "DEF:idle=%(file)s:idle:AVERAGE",
36                 "DEF:wait=%(file)s:wait:AVERAGE",
37                 "DEF:irq=%(file)s:irq:AVERAGE",
38                 "DEF:sirq=%(file)s:sirq:AVERAGE",
39
40                 "AREA:user#90EE90:%-15s" % _("User"),
41                 "VDEF:usermin=user,MINIMUM",
42                 "VDEF:usermax=user,MAXIMUM",
43                 "VDEF:useravg=user,AVERAGE",
44                 "GPRINT:usermax:%12s\:" % _("Maximum") + " %6.2lf" ,
45                 "GPRINT:usermin:%12s\:" % _("Minimum") + " %6.2lf",
46                 "GPRINT:useravg:%12s\:" % _("Average") + " %6.2lf\\n",
47
48                 "STACK:nice#4169E1:%-15s" % _("Nice"),
49                 "VDEF:nicemin=nice,MINIMUM",
50                 "VDEF:nicemax=nice,MAXIMUM",
51                 "VDEF:niceavg=nice,AVERAGE",
52                 "GPRINT:nicemax:%12s\:" % _("Maximum") + " %6.2lf" ,
53                 "GPRINT:nicemin:%12s\:" % _("Minimum") + " %6.2lf",
54                 "GPRINT:niceavg:%12s\:" % _("Average") + " %6.2lf\\n",
55
56                 "STACK:sys#DC143C:%-15s" % _("System"),
57                 "VDEF:sysmin=sys,MINIMUM",
58                 "VDEF:sysmax=sys,MAXIMUM",
59                 "VDEF:sysavg=sys,AVERAGE",
60                 "GPRINT:sysmax:%12s\:" % _("Maximum") + " %6.2lf" ,
61                 "GPRINT:sysmin:%12s\:" % _("Minimum") + " %6.2lf",
62                 "GPRINT:sysavg:%12s\:" % _("Average") + " %6.2lf\\n",
63
64                 "STACK:wait#483D8B:%-15s" % _("Wait"),
65                 "VDEF:waitmin=wait,MINIMUM",
66                 "VDEF:waitmax=wait,MAXIMUM",
67                 "VDEF:waitavg=wait,AVERAGE",
68                 "GPRINT:waitmax:%12s\:" % _("Maximum") + " %6.2lf" ,
69                 "GPRINT:waitmin:%12s\:" % _("Minimum") + " %6.2lf",
70                 "GPRINT:waitavg:%12s\:" % _("Average") + " %6.2lf\\n",
71
72                 "STACK:irq#DAA520:%-15s" % _("Interrupt"),
73                 "VDEF:irqmin=irq,MINIMUM",
74                 "VDEF:irqmax=irq,MAXIMUM",
75                 "VDEF:irqavg=irq,AVERAGE",
76                 "GPRINT:irqmax:%12s\:" % _("Maximum") + " %6.2lf" ,
77                 "GPRINT:irqmin:%12s\:" % _("Minimum") + " %6.2lf",
78                 "GPRINT:irqavg:%12s\:" % _("Average") + " %6.2lf\\n",
79
80                 "STACK:sirq#FFD700:%-15s" % _("Soft interrupt"),
81                 "VDEF:sirqmin=sirq,MINIMUM",
82                 "VDEF:sirqmax=sirq,MAXIMUM",
83                 "VDEF:sirqavg=sirq,AVERAGE",
84                 "GPRINT:sirqmax:%12s\:" % _("Maximum") + " %6.2lf" ,
85                 "GPRINT:sirqmin:%12s\:" % _("Minimum") + " %6.2lf",
86                 "GPRINT:sirqavg:%12s\:" % _("Average") + " %6.2lf\\n",
87
88                 "STACK:idle#EFEFEF:%-15s" % _("Idle"),
89                 "VDEF:idlemin=idle,MINIMUM",
90                 "VDEF:idlemax=idle,MAXIMUM",
91                 "VDEF:idleavg=idle,AVERAGE",
92                 "GPRINT:idlemax:%12s\:" % _("Maximum") + " %6.2lf" ,
93                 "GPRINT:idlemin:%12s\:" % _("Minimum") + " %6.2lf",
94                 "GPRINT:idleavg:%12s\:" % _("Average") + " %6.2lf\\n",
95         ]
96
97         lower_limit = 0
98
99         @property
100         def graph_title(self):
101                 return _("CPU usage")
102
103         @property
104         def graph_vertical_label(self):
105                 return _("Jiffies")
106
107
108 class ProcessorObject(base.Object):
109         rrd_schema = [
110                 "DS:user:DERIVE:0:U",
111                 "DS:nice:DERIVE:0:U",
112                 "DS:sys:DERIVE:0:U",
113                 "DS:idle:DERIVE:0:U",
114                 "DS:wait:DERIVE:0:U",
115                 "DS:irq:DERIVE:0:U",
116                 "DS:sirq:DERIVE:0:U",
117         ]
118
119         @property
120         def id(self):
121                 return "default"
122
123         def collect(self):
124                 """
125                         Reads the CPU usage.
126                 """
127                 f = None
128
129                 try:
130                         f = open("/proc/stat")
131
132                         for line in f.readlines():
133                                 if not line.startswith("cpu"):
134                                         continue
135
136                                 columns = line.split()
137                                 if len(columns) < 8:
138                                         continue
139
140                                 return (
141                                         columns[1], # user
142                                         columns[2], # nice
143                                         columns[3], # sys
144                                         columns[4], # idle
145                                         columns[5], # wait
146                                         columns[6], # irq
147                                         columns[7], # sirq
148                                 )
149                 finally:
150                         if f:
151                                 f.close()
152
153
154 class ProcessorPlugin(base.Plugin):
155         name = "processor"
156         description = "Processor Usage Plugin"
157
158         templates = [GraphTemplateProcessor]
159
160         interval = 30
161
162         @property
163         def objects(self):
164                 yield ProcessorObject(self)