]>
git.ipfire.org Git - collecty.git/blob - src/collecty/daemon.py
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 ###############################################################################
23 import multiprocessing
35 from .constants
import *
39 log
= logging
.getLogger("collecty")
41 class Collecty(object):
42 # The default interval, when all data is written to disk.
47 def __init__(self
, debug
=False):
50 # Reset timezone to UTC
51 # rrdtool is reading that from the environment
52 os
.environ
["TZ"] = "UTC"
54 # Enable debug logging when running in debug mode
56 log
.setLevel(logging
.DEBUG
)
60 # Indicates whether this process should be running or not.
63 # The write queue holds all collected pieces of data which
64 # will be written to disk later.
65 self
.write_queue
= WriteQueue(self
, self
.SUBMIT_INTERVAL
)
67 # Create worker threads
68 self
.worker_threads
= self
.create_worker_threads()
70 self
._timer
_queue
= queue
.PriorityQueue()
71 self
._worker
_queue
= queue
.Queue()
73 # Create a thread that connects to dbus and processes requests we
75 self
.bus
= bus
.Bus(self
)
78 for plugin
in plugins
.get():
79 self
.add_plugin(plugin
)
81 log
.debug(_("Collecty successfully initialized with %s plugins") \
84 log
.debug(_("Supported locales: %s") % ", ".join(locales
.get_supported_locales()))
86 def add_plugin(self
, plugin_class
):
87 # Try initialising a new plugin. If that fails, we will log the
88 # error and try to go on.
90 plugin
= plugin_class(self
)
92 log
.critical(_("Plugin %s could not be initialised") % plugin_class
, exc_info
=True)
95 self
.plugins
.append(plugin
)
99 for plugin
in self
.plugins
:
100 for template
in plugin
.templates
:
104 # Register signal handlers.
105 self
.register_signal_handler()
107 # Cannot do anything if no plugins have been initialised
109 log
.critical(_("No plugins have been initialised"))
115 # Initialise the timer queue
116 self
.initialise_timer_queue()
118 # Start worker threads
119 for w
in self
.worker_threads
:
122 # Run the write queue thread
123 self
.write_queue
.start()
125 # Regularly submit all data to disk.
128 # Try processing one event from the queue. If that succeeded
129 # we will retry immediately.
130 if self
.process_timer_queue():
133 # Otherwise we will sleep for a bit
134 time
.sleep(self
.HEARTBEAT
)
136 # Log warnings if the worker queue is filling up
137 queue_size
= self
._worker
_queue
.qsize()
139 log
.warning(_("Worker queue is filling up with %s events") % queue_size
)
141 except KeyboardInterrupt:
145 # Wait until all worker threads are finished
146 for w
in self
.worker_threads
:
149 # Stop the bus thread
152 # Write all collected data to disk before ending the main thread
153 self
.write_queue
.shutdown()
155 log
.debug(_("Main thread exited"))
161 log
.info(_("Received shutdown signal"))
164 # Propagating shutdown to all threads.
165 for w
in self
.worker_threads
:
168 def register_signal_handler(self
):
169 for s
in (signal
.SIGTERM
, signal
.SIGINT
, signal
.SIGUSR1
):
170 log
.debug(_("Registering signal %d") % s
)
172 signal
.signal(s
, self
.signal_handler
)
174 def signal_handler(self
, sig
, *args
, **kwargs
):
175 log
.info(_("Caught signal %d") % sig
)
177 if sig
in (signal
.SIGTERM
, signal
.SIGINT
):
178 # Shutdown this application.
181 elif sig
== signal
.SIGUSR1
:
183 self
.write_queue
.commit()
185 def get_plugin_from_template(self
, template_name
):
186 for plugin
in self
.plugins
:
187 if not template_name
in [t
.name
for t
in plugin
.templates
]:
192 def generate_graph(self
, template_name
, *args
, **kwargs
):
193 plugin
= self
.get_plugin_from_template(template_name
)
195 raise RuntimeError("Could not find template %s" % template_name
)
197 return plugin
.generate_graph(template_name
, *args
, **kwargs
)
199 def create_worker_threads(self
, num
=None):
201 Creates a number of worker threads
203 # If no number of threads is given, we will create as many as we have
204 # active processor cores but never less than two.
206 num
= max(multiprocessing
.cpu_count(), 2)
210 for id in range(num
):
211 worker_thread
= WorkerThread(self
, id)
212 worker_threads
.append(worker_thread
)
214 return worker_threads
216 def initialise_timer_queue(self
):
217 for p
in self
.plugins
:
218 timer
= PluginTimer(p
)
220 self
._timer
_queue
.put(timer
)
222 def process_timer_queue(self
):
223 # Take the item from the timer queue that is to be due first
224 timer
= self
._timer
_queue
.get()
227 # If the timer event is to be executed, we will put the plugin
228 # into the worker queue and reset the timer
230 self
._worker
_queue
.put(timer
.plugin
)
231 timer
.reset_deadline()
235 # Put the timer back into the timer queue.
236 self
._timer
_queue
.put(timer
)
239 class WorkerThread(threading
.Thread
):
242 def __init__(self
, collecty
, id):
243 threading
.Thread
.__init
__(self
)
246 self
.log
= logging
.getLogger("collecty.worker")
247 self
.log
.propagate
= 1
249 self
.collecty
= collecty
252 self
.log
.debug(_("Worker thread %s has been initialised") % self
.id)
257 The queue this thread is getting events from
259 return self
.collecty
._worker
_queue
262 self
.log
.debug(_("Worker thread %s has been started") % self
.id)
267 plugin
= self
.queue
.get(block
=True, timeout
=self
.HEARTBEAT
)
269 # If the queue has been empty we just retry
273 # Execute the collect operation for this plugin
276 self
.log
.debug(_("Worker thread %s has been terminated") % self
.id)
282 class WriteQueue(threading
.Thread
):
283 def __init__(self
, collecty
, submit_interval
):
284 threading
.Thread
.__init
__(self
)
287 self
.collecty
= collecty
289 self
.log
= logging
.getLogger("collecty.queue")
290 self
.log
.propagate
= 1
292 self
.timer
= plugins
.Timer(submit_interval
)
293 self
._queue
= queue
.PriorityQueue()
295 self
.log
.debug(_("Initialised write queue"))
298 self
.log
.debug(_("Write queue process started"))
305 # Wait until the timer has successfully elapsed.
306 if self
.timer
.wait():
310 self
.log
.debug(_("Write queue process stopped"))
316 # Wait until all data has been written.
319 def add(self
, object, time
, data
):
320 result
= QueueObject(object.file, time
, data
)
321 self
._queue
.put(result
)
325 Flushes the read data to disk.
327 # There is nothing to do if the queue is empty
328 if self
._queue
.empty():
329 self
.log
.debug(_("No data to commit"))
332 time_start
= time
.time()
334 self
.log
.debug(_("Submitting data to the databases..."))
336 # Get all objects from the queue and group them by the RRD file
337 # to commit them all at once
339 while not self
._queue
.empty():
340 result
= self
._queue
.get()
343 results
[result
.file].append(result
)
345 results
[result
.file] = [result
]
347 # Write the collected data to disk
348 for filename
, results
in list(results
.items()):
349 self
._commit
_file
(filename
, results
)
351 duration
= time
.time() - time_start
352 self
.log
.debug(_("Emptied write queue in %.2fs") % duration
)
354 def _commit_file(self
, filename
, results
):
355 self
.log
.debug(_("Committing %(counter)s entries to %(filename)s") \
356 % { "counter" : len(results
), "filename" : filename
})
358 for result
in results
:
359 self
.log
.debug(" %s: %s" % (result
.time
, result
.data
))
362 rrdtool
.update(filename
, *["%s" % r
for r
in results
])
364 # Catch operational errors like unreadable/unwritable RRD databases
365 # or those where the format has changed. The collected data will be lost.
366 except rrdtool
.OperationalError
as e
:
367 self
.log
.critical(_("Could not update RRD database %s: %s") \
371 class QueueObject(object):
372 def __init__(self
, file, time
, data
):
378 return "%s:%s" % (self
.time
.strftime("%s"), self
.data
)
380 def __lt__(self
, other
):
381 return self
.time
< other
.time
384 class PluginTimer(object):
385 def __init__(self
, plugin
):
388 self
.deadline
= datetime
.datetime
.utcnow()
391 return "<%s %s>" % (self
.__class
__.__name
__, self
.deadline
)
393 def __lt__(self
, other
):
394 return self
.deadline
< other
.deadline
396 def reset_deadline(self
):
397 self
.deadline
= datetime
.datetime
.utcnow() \
398 + datetime
.timedelta(seconds
=self
.plugin
.interval
)
401 return datetime
.datetime
.utcnow() >= self
.deadline