Commit ada0ca3f authored by David Douard's avatar David Douard
Browse files

[hooks] add a looping task that dumps the stats regularly in a file

parent 4b8253fb3125
......@@ -870,6 +870,18 @@ repository.',
the repository',
'group': 'email', 'level': 1,
{'type' : 'int',
'default': 0,
'help': 'interval (in seconds) at which stats are dumped in the logstat file; set 0 to disable',
'group': 'main', 'level': 2,
{'type' : 'string',
'default': Method('default_stats_file'),
'help': 'file where stats for the instance should be written',
'group': 'main', 'level': 2,
......@@ -953,6 +965,13 @@ the repository',
log_path = os.path.join(_INSTALL_PREFIX, 'var', 'log', 'cubicweb', '%s-%s.log')
return log_path % (self.appid,
def default_stats_file(self):
"""return default path to the stats file of the instance'server"""
logfile = self.default_log_file()
if logfile.endswith('.log'):
logfile = logfile[:-4]
return logfile + '.stats'
def default_pid_file(self):
"""return default path to the pid file of the instance'server"""
if self.mode == 'system':
......@@ -77,6 +77,8 @@ class DevConfiguration(ServerConfiguration, WebConfiguration):
def default_log_file(self):
return None
def default_stats_file(self):
return None
def cleanup_sys_modules(config):
# copyright 2014 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
# contact --
# This file is part of CubicWeb.
# CubicWeb is free software: you can redistribute it and/or modify it under the
# terms of the GNU Lesser General Public License as published by the Free
# Software Foundation, either version 2.1 of the License, or (at your option)
# any later version.
# CubicWeb 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 Lesser General Public License for more
# details.
# You should have received a copy of the GNU Lesser General Public License along
# with CubicWeb. If not, see <>.
"""looping task for dumping instance's stats in a file
__docformat__ = "restructuredtext en"
from datetime import datetime
import json
from cubicweb.server import hook
class LogStatsStartHook(hook.Hook):
"""register task to regularly dump instance's stats in a file
data are stored as one json entry per row
__regid__ = 'cubicweb.hook.logstats.start'
events = ('server_startup',)
def __call__(self):
interval = self.repo.config.get('logstat-interval', 0)
if interval <= 0:
def dump_stats(repo):
statsfile = repo.config.get('logstat-file')
with repo.internal_cnx() as cnx:
stats = cnx.call_service('repo_stats')
gcstats = cnx.call_service('repo_gc_stats', nmax=5)
allstats = {'resources': stats,
'memory': gcstats,
'timestamp': datetime.utcnow().isoformat(),
with open(statsfile, 'ab') as ofile:
json.dump(allstats, ofile)
except IOError:
repo.warning('Cannot open stats file for writing: %s', statsfile)
self.repo.looping_task(interval, dump_stats, self.repo)
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment