2 ###############################################################################
4 # collecty - A system statistics collection daemon for IPFire #
5 # Copyright (C) 2012 IPFire development team #
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. #
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. #
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/>. #
20 ###############################################################################
22 from __future__
import division
30 SYS_CLASS_NET
= "/sys/class/net"
33 COLOUR_RX_AREA
= "%sAA" % COLOUR_RX
35 COLOUR_TX_AREA
= "%sAA" % COLOUR_TX
37 class GraphTemplateInterfaceBits(base
.GraphTemplate
):
38 name
= "interface-bits"
43 "DEF:bytes_rx=%(file)s:bytes_rx:AVERAGE",
44 "DEF:bytes_tx=%(file)s:bytes_tx:AVERAGE",
46 # Convert everything into bits.
47 "CDEF:bits_rx=bytes_rx,8,*",
48 "CDEF:bits_tx=bytes_tx,8,*",
51 "VDEF:bits_rx_95p=bits_rx,95,PERCENT",
52 "VDEF:bits_tx_95p=bits_tx,95,PERCENT",
54 # Draw the received area.
55 "AREA:bits_rx#%s:%-15s" % (COLOUR_RX_AREA
, _("Received")),
56 "VDEF:bits_rx_min=bits_rx,MINIMUM",
57 "VDEF:bits_rx_max=bits_rx,MAXIMUM",
58 "VDEF:bits_rx_avg=bits_rx,AVERAGE",
59 "GPRINT:bits_rx_max:%12s\: " % _("Maximum") + _("%8.2lf %sbps"),
60 "GPRINT:bits_rx_min:%12s\: " % _("Minimum") + _("%8.2lf %sbps"),
61 "GPRINT:bits_rx_avg:%12s\: " % _("Average") + _("%8.2lf %sbps") + "\\n",
63 # Draw the transmitted area.
64 "AREA:bits_tx#%s:%-15s" % (COLOUR_TX_AREA
, _("Transmitted")),
65 "VDEF:bits_tx_min=bits_tx,MINIMUM",
66 "VDEF:bits_tx_max=bits_tx,MAXIMUM",
67 "VDEF:bits_tx_avg=bits_tx,AVERAGE",
68 "GPRINT:bits_tx_max:%12s\: " % _("Maximum") + _("%8.2lf %sbps"),
69 "GPRINT:bits_tx_min:%12s\: " % _("Minimum") + _("%8.2lf %sbps"),
70 "GPRINT:bits_tx_avg:%12s\: " % _("Average") + _("%8.2lf %sbps") + "\\n",
73 "LINE1:bits_rx#%s" % COLOUR_RX
,
74 "LINE1:bits_tx#%s" % COLOUR_TX
,
77 "COMMENT:--- %s ---\\n" % _("95th percentile"),
78 "LINE2:bits_rx_95p#%s:%-15s" % (COLOUR_RX
, _("Received")),
79 "GPRINT:bits_rx_95p:%s" % _("%8.2lf %sbps") + "\\n",
80 "LINE2:bits_tx_95p#%s:%-15s" % (COLOUR_TX
, _("Transmitted")),
81 "GPRINT:bits_tx_95p:%s" % _("%8.2lf %sbps") + "\\n",
85 def rrd_graph_args(self
):
87 "--title", _("Bandwidth usage on %(interface)s"),
88 "--vertical-label", _("Bit/s"),
92 class GraphTemplateInterfacePackets(base
.GraphTemplate
):
93 name
= "interface-packets"
98 "DEF:packets_rx=%(file)s:packets_rx:AVERAGE",
99 "DEF:packets_tx=%(file)s:packets_tx:AVERAGE",
101 # Draw the received area.
102 "AREA:packets_rx#%s:%-15s" % (COLOUR_RX_AREA
, _("Received")),
103 "VDEF:packets_rx_min=packets_rx,MINIMUM",
104 "VDEF:packets_rx_max=packets_rx,MAXIMUM",
105 "VDEF:packets_rx_avg=packets_rx,AVERAGE",
106 "GPRINT:packets_rx_max:%12s\: " % _("Maximum") + _("%8.0lf %spps"),
107 "GPRINT:packets_rx_min:%12s\: " % _("Minimum") + _("%8.0lf %spps"),
108 "GPRINT:packets_rx_avg:%12s\: " % _("Average") + _("%8.2lf %spps") + "\\n",
110 # Draw the transmitted area.
111 "AREA:packets_tx#%s:%-15s" % (COLOUR_TX_AREA
, _("Transmitted")),
112 "VDEF:packets_tx_min=packets_tx,MINIMUM",
113 "VDEF:packets_tx_max=packets_tx,MAXIMUM",
114 "VDEF:packets_tx_avg=packets_tx,AVERAGE",
115 "GPRINT:packets_tx_max:%12s\: " % _("Maximum") + _("%8.0lf %spps"),
116 "GPRINT:packets_tx_min:%12s\: " % _("Minimum") + _("%8.0lf %spps"),
117 "GPRINT:packets_tx_avg:%12s\: " % _("Average") + _("%8.2lf %spps") + "\\n",
119 # Draw outlines of the areas on top.
120 "LINE1:packets_rx#%s" % COLOUR_RX
,
121 "LINE1:packets_tx#%s" % COLOUR_TX
,
125 def rrd_graph_args(self
):
127 "--title", _("Transferred packets on %(interface)s"),
128 "--vertical-label", _("Packets/s"),
132 class GraphTemplateInterfaceErrors(base
.GraphTemplate
):
133 name
= "interface-errors"
138 "DEF:errors_rx=%(file)s:errors_rx:AVERAGE",
139 "DEF:errors_tx=%(file)s:errors_tx:AVERAGE",
140 "DEF:dropped_rx=%(file)s:dropped_rx:AVERAGE",
141 "DEF:dropped_tx=%(file)s:dropped_tx:AVERAGE",
142 "DEF:collisions=%(file)s:collisions:AVERAGE",
144 # Invert the transmitted packets to create upside down graph.
145 "CDEF:errors_tx_inv=errors_tx,-1,*",
146 "CDEF:dropped_tx_inv=dropped_tx,-1,*",
148 # Draw the receive errors.
149 "AREA:errors_rx#228B2277:%-15s" % _("Receive errors"),
150 "VDEF:errors_rx_min=errors_rx,MINIMUM",
151 "VDEF:errors_rx_max=errors_rx,MAXIMUM",
152 "VDEF:errors_rx_avg=errors_rx,AVERAGE",
153 "GPRINT:errors_rx_max:%12s\: " % _("Maximum") + _("%8.0lf %spps"),
154 "GPRINT:errors_rx_min:%12s\: " % _("Minimum") + _("%8.0lf %spps"),
155 "GPRINT:errors_rx_avg:%12s\: " % _("Average") + _("%8.2lf %spps") + "\\n",
156 "LINE1:errors_rx#228B22",
158 # Draw the transmit errors.
159 "AREA:errors_tx_inv#B2222277:%-15s" % _("Transmit errors"),
160 "VDEF:errors_tx_min=errors_tx,MINIMUM",
161 "VDEF:errors_tx_max=errors_tx,MAXIMUM",
162 "VDEF:errors_tx_avg=errors_tx,AVERAGE",
163 "GPRINT:errors_tx_max:%12s\: " % _("Maximum") + _("%8.0lf %spps"),
164 "GPRINT:errors_tx_min:%12s\: " % _("Minimum") + _("%8.0lf %spps"),
165 "GPRINT:errors_tx_avg:%12s\: " % _("Average") + _("%8.2lf %spps") + "\\n",
166 "LINE1:errors_tx_inv#B22222",
168 # Draw the receive drops.
169 "LINE2:dropped_rx#228B22:%-15s" % _("Receive drops"),
170 "VDEF:dropped_rx_min=dropped_rx,MINIMUM",
171 "VDEF:dropped_rx_max=dropped_rx,MAXIMUM",
172 "VDEF:dropped_rx_avg=dropped_rx,AVERAGE",
173 "GPRINT:dropped_rx_max:%12s\: " % _("Maximum") + _("%8.0lf %spps"),
174 "GPRINT:dropped_rx_min:%12s\: " % _("Minimum") + _("%8.0lf %spps"),
175 "GPRINT:dropped_rx_avg:%12s\: " % _("Average") + _("%8.2lf %spps") + "\\n",
176 "LINE1:dropped_rx#228B22",
178 # Draw the transmit drops.
179 "LINE2:dropped_tx#B22222:%-15s" % _("Transmit drops"),
180 "VDEF:dropped_tx_min=dropped_tx,MINIMUM",
181 "VDEF:dropped_tx_max=dropped_tx,MAXIMUM",
182 "VDEF:dropped_tx_avg=dropped_tx,AVERAGE",
183 "GPRINT:dropped_tx_max:%12s\: " % _("Maximum") + _("%8.0lf %spps"),
184 "GPRINT:dropped_tx_min:%12s\: " % _("Minimum") + _("%8.0lf %spps"),
185 "GPRINT:dropped_tx_avg:%12s\: " % _("Average") + _("%8.2lf %spps") + "\\n",
186 "LINE1:dropped_tx#B22222",
188 # Draw the collisions as a line.
189 "LINE3:collisions#8B0000:%-15s" % _("Collisions") + "\\n",
193 def rrd_graph_args(self
):
195 "--title", _("Errors/dropped packets on %(interface)s"),
196 "--vertical-label", _("Packets/s"),
200 class DataSourceInterface(base
.DataSource
):
202 description
= "Interface Statistics Data Source"
205 GraphTemplateInterfaceBits
,
206 GraphTemplateInterfacePackets
,
207 GraphTemplateInterfaceErrors
,
211 "DS:bytes_rx:DERIVE:0:U",
212 "DS:bytes_tx:DERIVE:0:U",
213 "DS:collisions:DERIVE:0:U",
214 "DS:dropped_rx:DERIVE:0:U",
215 "DS:dropped_tx:DERIVE:0:U",
216 "DS:errors_rx:DERIVE:0:U",
217 "DS:errors_tx:DERIVE:0:U",
218 "DS:multicast:DERIVE:0:U",
219 "DS:packets_rx:DERIVE:0:U",
220 "DS:packets_tx:DERIVE:0:U",
224 def autocreate(cls
, collecty
, **kwargs
):
225 if not os
.path
.exists(SYS_CLASS_NET
):
229 for interface
in os
.listdir(SYS_CLASS_NET
):
230 # Skip some unwanted interfaces.
231 if interface
== "lo" or interface
.startswith("mon."):
234 path
= os
.path
.join(SYS_CLASS_NET
, interface
)
235 if not os
.path
.isdir(path
):
238 instance
= cls(collecty
, interface
=interface
)
239 instances
.append(instance
)
243 def init(self
, **kwargs
):
244 self
.interface
= kwargs
.get("interface")
248 return "-".join((self
.name
, self
.interface
))
251 interface_path
= os
.path
.join(SYS_CLASS_NET
, self
.interface
)
253 # Check if the interface exists.
254 if not os
.path
.exists(interface_path
):
255 self
.log
.debug(_("Interface %s does not exists. Cannot collect.") \
260 "rx_bytes", "tx_bytes",
262 "rx_dropped", "tx_dropped",
263 "rx_errors", "tx_errors",
265 "rx_packets", "tx_packets",
270 path
= os
.path
.join(interface_path
, "statistics", file)
272 # Open file and read it's content.