[hooks] add a looping task that dumps the stats regularly in a file
authorDavid Douard <david.douard@logilab.fr>
Wed, 22 Apr 2015 11:00:50 +0200
changeset 10308 3f94034cc972
parent 10307 4b8253fb3125
child 10309 35bf741203d6
[hooks] add a looping task that dumps the stats regularly in a file
cwconfig.py
devtools/devctl.py
hooks/logstats.py
--- a/cwconfig.py	Mon Feb 23 09:02:41 2015 +0100
+++ b/cwconfig.py	Wed Apr 22 11:00:50 2015 +0200
@@ -870,6 +870,18 @@
 the repository',
           'group': 'email', 'level': 1,
           }),
+        ('logstat-interval',
+         {'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,
+          }),
+        ('logstat-file',
+         {'type' : 'string',
+          'default': Method('default_stats_file'),
+          'help': 'file where stats for the instance should be written',
+          'group': 'main', 'level': 2,
+          }),
         )
 
     @classmethod
@@ -953,6 +965,13 @@
             log_path = os.path.join(_INSTALL_PREFIX, 'var', 'log', 'cubicweb', '%s-%s.log')
             return log_path % (self.appid, self.name)
 
+    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':
--- a/devtools/devctl.py	Mon Feb 23 09:02:41 2015 +0100
+++ b/devtools/devctl.py	Wed Apr 22 11:00:50 2015 +0200
@@ -77,6 +77,8 @@
         pass
     def default_log_file(self):
         return None
+    def default_stats_file(self):
+        return None
 
 
 def cleanup_sys_modules(config):
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/hooks/logstats.py	Wed Apr 22 11:00:50 2015 +0200
@@ -0,0 +1,59 @@
+# copyright 2014 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
+# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr
+#
+# 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 <http://www.gnu.org/licenses/>.
+
+"""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:
+            return            
+
+        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(),
+                       }
+            try:
+                with open(statsfile, 'ab') as ofile:
+                    json.dump(allstats, ofile)
+                    ofile.write('\n')
+            except IOError:
+                repo.warning('Cannot open stats file for writing: %s', statsfile)
+                    
+        self.repo.looping_task(interval, dump_stats, self.repo)