Patchwork [1,of,8] loggingutil: add basic logger backends

login
register
mail settings
Submitter Yuya Nishihara
Date Dec. 4, 2018, 1:24 p.m.
Message ID <b740d4b4a1af3d2c4325.1543929855@mimosa>
Download mbox | patch
Permalink /patch/36948/
State Accepted
Headers show

Comments

Yuya Nishihara - Dec. 4, 2018, 1:24 p.m.
# HG changeset patch
# User Yuya Nishihara <yuya@tcha.org>
# Date 1542535086 -32400
#      Sun Nov 18 18:58:06 2018 +0900
# Node ID b740d4b4a1af3d2c4325973be876acb87f3fa1ae
# Parent  04ebdb33e5d05f4155d6bb3330a0a4e1b68a96a4
loggingutil: add basic logger backends

These classes will be used in command server. They are similar to
the blackboxlogger, but it can't be factored out since the blackbox is so
tightly coupled with a repo object.

Patch

diff --git a/mercurial/loggingutil.py b/mercurial/loggingutil.py
--- a/mercurial/loggingutil.py
+++ b/mercurial/loggingutil.py
@@ -14,6 +14,12 @@  from . import (
     pycompat,
 )
 
+from .utils import (
+    dateutil,
+    procutil,
+    stringutil,
+)
+
 def openlogfile(ui, vfs, name, maxfiles=0, maxsize=0):
     """Open log file in append mode, with optional rotation
 
@@ -49,6 +55,58 @@  def openlogfile(ui, vfs, name, maxfiles=
                        newpath=maxfiles > 0 and path + '.1')
     return vfs(name, 'a', makeparentdirs=False)
 
+def _formatlogline(msg):
+    date = dateutil.datestr(format=b'%Y/%m/%d %H:%M:%S')
+    pid = procutil.getpid()
+    return b'%s (%d)> %s' % (date, pid, msg)
+
+def _matchevent(event, tracked):
+    return b'*' in tracked or event in tracked
+
+class filelogger(object):
+    """Basic logger backed by physical file with optional rotation"""
+
+    def __init__(self, vfs, name, tracked, maxfiles=0, maxsize=0):
+        self._vfs = vfs
+        self._name = name
+        self._trackedevents = set(tracked)
+        self._maxfiles = maxfiles
+        self._maxsize = maxsize
+
+    def tracked(self, event):
+        return _matchevent(event, self._trackedevents)
+
+    def log(self, ui, event, msg, opts):
+        line = _formatlogline(msg)
+        try:
+            with openlogfile(ui, self._vfs, self._name,
+                             maxfiles=self._maxfiles,
+                             maxsize=self._maxsize) as fp:
+                fp.write(line)
+        except IOError as err:
+            ui.debug(b'cannot write to %s: %s\n'
+                     % (self._name, stringutil.forcebytestr(err)))
+
+class fileobjectlogger(object):
+    """Basic logger backed by file-like object"""
+
+    def __init__(self, fp, tracked):
+        self._fp = fp
+        self._trackedevents = set(tracked)
+
+    def tracked(self, event):
+        return _matchevent(event, self._trackedevents)
+
+    def log(self, ui, event, msg, opts):
+        line = _formatlogline(msg)
+        try:
+            self._fp.write(line)
+            self._fp.flush()
+        except IOError as err:
+            ui.debug(b'cannot write to %s: %s\n'
+                     % (stringutil.forcebytestr(self._fp.name),
+                        stringutil.forcebytestr(err)))
+
 class proxylogger(object):
     """Forward log events to another logger to be set later"""