blackbox.py
244 lines
| 7.0 KiB
| text/x-python
|
PythonLexer
/ hgext / blackbox.py
|
r18676 | # blackbox.py - log repository events to a file for post-mortem debugging | ||
|
r18669 | # | ||
|
r18676 | # Copyright 2010 Nicolas Dumazet | ||
|
r18669 | # Copyright 2013 Facebook, Inc. | ||
# | ||||
# This software may be used and distributed according to the terms of the | ||||
# GNU General Public License version 2 or any later version. | ||||
"""log repository events to a blackbox for debugging | ||||
Logs event information to .hg/blackbox.log to help debug and diagnose problems. | ||||
The events that get logged can be configured via the blackbox.track config key. | ||||
|
r28246 | |||
|
r19162 | Examples:: | ||
|
r18669 | |||
[blackbox] | ||||
track = * | ||||
|
r28303 | # dirty is *EXPENSIVE* (slow); | ||
# each log entry indicates `+` if the repository is dirty, like :hg:`id`. | ||||
|
r28246 | dirty = True | ||
|
r28305 | # record the source of log messages | ||
logsource = True | ||||
|
r18669 | |||
[blackbox] | ||||
track = command, commandfinish, commandexception, exthook, pythonhook | ||||
[blackbox] | ||||
track = incoming | ||||
|
r19066 | [blackbox] | ||
# limit the size of a log file | ||||
maxsize = 1.5 MB | ||||
# rotate up to N log files when the current one gets too big | ||||
maxfiles = 3 | ||||
|
r18669 | """ | ||
|
r28090 | from __future__ import absolute_import | ||
import errno | ||||
import re | ||||
|
r18669 | from mercurial.i18n import _ | ||
|
r28245 | from mercurial.node import hex | ||
|
r28090 | from mercurial import ( | ||
|
r32337 | registrar, | ||
|
r28248 | ui as uimod, | ||
|
r28090 | util, | ||
) | ||||
|
r18669 | |||
|
r29841 | # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for | ||
|
r25186 | # extensions which SHIP WITH MERCURIAL. Non-mainline extensions should | ||
# be specifying the version(s) of Mercurial they are tested with, or | ||||
# leave the attribute unspecified. | ||||
|
r29841 | testedwith = 'ships-with-hg-core' | ||
r33129 | ||||
cmdtable = {} | ||||
command = registrar.command(cmdtable) | ||||
r33130 | configtable = {} | |||
configitem = registrar.configitem(configtable) | ||||
r33186 | configitem('blackbox', 'dirty', | |||
default=False, | ||||
) | ||||
r33130 | configitem('blackbox', 'maxsize', | |||
r33131 | default='1 MB', | |||
r33130 | ) | |||
r33187 | configitem('blackbox', 'logsource', | |||
default=False, | ||||
) | ||||
|
r34746 | configitem('blackbox', 'maxfiles', | ||
default=7, | ||||
) | ||||
|
r34518 | configitem('blackbox', 'track', | ||
|
r34584 | default=lambda: ['*'], | ||
|
r34518 | ) | ||
r33130 | ||||
|
r28247 | lastui = None | ||
|
r18669 | |||
|
r34301 | def _openlogfile(ui, vfs): | ||
def rotate(oldpath, newpath): | ||||
try: | ||||
vfs.unlink(newpath) | ||||
except OSError as err: | ||||
if err.errno != errno.ENOENT: | ||||
ui.debug("warning: cannot remove '%s': %s\n" % | ||||
(newpath, err.strerror)) | ||||
try: | ||||
if newpath: | ||||
vfs.rename(oldpath, newpath) | ||||
except OSError as err: | ||||
if err.errno != errno.ENOENT: | ||||
ui.debug("warning: cannot rename '%s' to '%s': %s\n" % | ||||
(newpath, oldpath, err.strerror)) | ||||
maxsize = ui.configbytes('blackbox', 'maxsize') | ||||
name = 'blackbox.log' | ||||
if maxsize > 0: | ||||
try: | ||||
st = vfs.stat(name) | ||||
except OSError: | ||||
pass | ||||
else: | ||||
if st.st_size >= maxsize: | ||||
path = vfs.join(name) | ||||
|
r34746 | maxfiles = ui.configint('blackbox', 'maxfiles') | ||
|
r34301 | for i in xrange(maxfiles - 1, 1, -1): | ||
rotate(oldpath='%s.%d' % (path, i - 1), | ||||
newpath='%s.%d' % (path, i)) | ||||
rotate(oldpath=path, | ||||
newpath=maxfiles > 0 and path + '.1') | ||||
return vfs(name, 'a') | ||||
|
r18669 | def wrapui(ui): | ||
class blackboxui(ui.__class__): | ||||
|
r34112 | @property | ||
def _bbvfs(self): | ||||
|
r34300 | vfs = None | ||
|
r34112 | repo = getattr(self, '_bbrepo', None) | ||
if repo: | ||||
|
r34300 | vfs = repo.vfs | ||
if not vfs.isdir('.'): | ||||
vfs = None | ||||
return vfs | ||||
|
r34112 | |||
|
r18669 | @util.propertycache | ||
def track(self): | ||||
|
r34518 | return self.configlist('blackbox', 'track') | ||
|
r18669 | |||
def log(self, event, *msg, **opts): | ||||
|
r28247 | global lastui | ||
|
r18669 | super(blackboxui, self).log(event, *msg, **opts) | ||
if not '*' in self.track and not event in self.track: | ||||
return | ||||
|
r34111 | if self._bbvfs: | ||
|
r28247 | ui = self | ||
|
r18669 | else: | ||
# certain ui instances exist outside the context of | ||||
# a repo, so just default to the last blackbox that | ||||
# was seen. | ||||
|
r28247 | ui = lastui | ||
|
r18669 | |||
|
r34111 | if not ui: | ||
|
r28407 | return | ||
|
r34300 | vfs = ui._bbvfs | ||
if not vfs: | ||||
return | ||||
|
r34275 | repo = getattr(ui, '_bbrepo', None) | ||
if not lastui or repo: | ||||
|
r28407 | lastui = ui | ||
|
r34275 | if getattr(ui, '_bbinlog', False): | ||
|
r34111 | # recursion and failure guard | ||
|
r28407 | return | ||
|
r34276 | ui._bbinlog = True | ||
default = self.configdate('devel', 'default-date') | ||||
date = util.datestr(default, '%Y/%m/%d %H:%M:%S') | ||||
user = util.getuser() | ||||
pid = '%d' % util.getpid() | ||||
formattedmsg = msg[0] % msg[1:] | ||||
rev = '(unknown)' | ||||
changed = '' | ||||
if repo: | ||||
ctx = repo[None] | ||||
parents = ctx.parents() | ||||
rev = ('+'.join([hex(p.node()) for p in parents])) | ||||
if (ui.configbool('blackbox', 'dirty') and | ||||
ctx.dirty(missing=True, merge=False, branch=False)): | ||||
changed = '+' | ||||
if ui.configbool('blackbox', 'logsource'): | ||||
src = ' [%s]' % event | ||||
else: | ||||
src = '' | ||||
|
r28407 | try: | ||
|
r34276 | fmt = '%s %s @%s%s (%s)%s> %s' | ||
args = (date, user, rev, changed, pid, src, formattedmsg) | ||||
|
r34301 | with _openlogfile(ui, vfs) as fp: | ||
|
r34276 | fp.write(fmt % args) | ||
except (IOError, OSError) as err: | ||||
self.debug('warning: cannot write to blackbox.log: %s\n' % | ||||
err.strerror) | ||||
# do not restore _bbinlog intentionally to avoid failed | ||||
# logging again | ||||
else: | ||||
ui._bbinlog = False | ||||
|
r18669 | |||
def setrepo(self, repo): | ||||
|
r28248 | self._bbrepo = repo | ||
|
r18669 | |||
ui.__class__ = blackboxui | ||||
|
r28248 | uimod.ui = blackboxui | ||
|
r18669 | |||
def uisetup(ui): | ||||
wrapui(ui) | ||||
def reposetup(ui, repo): | ||||
# During 'hg pull' a httppeer repo is created to represent the remote repo. | ||||
# It doesn't have a .hg directory to put a blackbox in, so we don't do | ||||
# the blackbox setup for it. | ||||
if not repo.local(): | ||||
return | ||||
|
r19230 | if util.safehasattr(ui, 'setrepo'): | ||
ui.setrepo(repo) | ||||
|
r34277 | |||
# Set lastui even if ui.log is not called. This gives blackbox a | ||||
# fallback place to log. | ||||
global lastui | ||||
if lastui is None: | ||||
lastui = ui | ||||
|
r33436 | repo._wlockfreeprefix.add('blackbox.log') | ||
|
r18673 | |||
@command('^blackbox', | ||||
[('l', 'limit', 10, _('the number of events to show')), | ||||
], | ||||
_('hg blackbox [OPTION]...')) | ||||
def blackbox(ui, repo, *revs, **opts): | ||||
'''view the recent repository events | ||||
''' | ||||
|
r28026 | if not repo.vfs.exists('blackbox.log'): | ||
|
r18673 | return | ||
limit = opts.get('limit') | ||||
|
r28244 | fp = repo.vfs('blackbox.log', 'r') | ||
lines = fp.read().split('\n') | ||||
|
r18673 | |||
count = 0 | ||||
output = [] | ||||
for line in reversed(lines): | ||||
if count >= limit: | ||||
break | ||||
# count the commands by matching lines like: 2013/01/23 19:13:36 root> | ||||
if re.match('^\d{4}/\d{2}/\d{2} \d{2}:\d{2}:\d{2} .*> .*', line): | ||||
count += 1 | ||||
output.append(line) | ||||
ui.status('\n'.join(reversed(output))) | ||||