| Lint Skipped |
| Unit Tests Skipped |
https://www.mercurial-scm.org/repo/hg/rev/56132ebd14c6 added blackbox.ignore, which is basically what this was doing.
| Path | Packages | |||
|---|---|---|---|---|
| M | hgext/blackbox.py (39 lines) | |||
| M | tests/test-blackbox.t (41 lines) |
| Commit | Parents | Author | Summary | Date |
|---|---|---|---|---|
| Kyle Lippincott | Jan 31 2019, 2:11 PM |
| # blackbox.py - log repository events to a file for post-mortem debugging | # blackbox.py - log repository events to a file for post-mortem debugging | ||||
| # | # | ||||
| # Copyright 2010 Nicolas Dumazet | # Copyright 2010 Nicolas Dumazet | ||||
| # Copyright 2013 Facebook, Inc. | # Copyright 2013 Facebook, Inc. | ||||
| # | # | ||||
| # This software may be used and distributed according to the terms of the | # This software may be used and distributed according to the terms of the | ||||
| # GNU General Public License version 2 or any later version. | # GNU General Public License version 2 or any later version. | ||||
| """log repository events to a blackbox for debugging | """log repository events to a blackbox for debugging | ||||
| Logs event information to .hg/blackbox.log to help debug and diagnose problems. | 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; | The events that get logged can be configured via the blackbox.track and | ||||
| this takes a list of regular expressions. As a special rule, if any item in the | blackbox.notrack config keys; these take a list of regular expressions. If an | ||||
| list is the string '*', everything is logged (default: '*'). | event matches an item in blackbox.notrack, it is not logged, otherwise if it | ||||
| matches an item in blackbox.track, it is logged. | |||||
| If blackbox.track contains an item that is just '*', blackbox.track matches | |||||
| everything (but blackbox.notrack still takes precedence). | |||||
| By default, blackbox.track=* and blackbox.untrack is empty, causing all events | |||||
| to be logged. | |||||
| Examples:: | Examples:: | ||||
| [blackbox] | [blackbox] | ||||
| # log everything | # log everything | ||||
| track = * | track = * | ||||
| # dirty is *EXPENSIVE* (slow); | # dirty is *EXPENSIVE* (slow); | ||||
| # each log entry indicates `+` if the repository is dirty, like :hg:`id`. | # each log entry indicates `+` if the repository is dirty, like :hg:`id`. | ||||
| dirty = True | dirty = True | ||||
| # record the source of log messages | # record the source of log messages | ||||
| logsource = True | logsource = True | ||||
| [blackbox] | [blackbox] | ||||
| # log every event starting with 'command' (including 'command' itself), and | # log every event starting with 'command' (including 'command' itself), and | ||||
| # everything ending with 'hook' (including 'hook' itself). | # everything ending with 'hook' (including 'hook' itself). | ||||
| track = command.*, .*hook | track = command.*, .*hook | ||||
| # explicitly ignore pythonhook | |||||
| notrack = pythonhook | |||||
| [blackbox] | [blackbox] | ||||
| track = incoming | track = incoming | ||||
| [blackbox] | [blackbox] | ||||
| # track = * is the default, so doesn't need to be specified here; | |||||
| # this ignores events ending with 'hook' (and 'hook' itself) | |||||
| notrack = .*hook | |||||
| [blackbox] | |||||
| # limit the size of a log file | # limit the size of a log file | ||||
| maxsize = 1.5 MB | maxsize = 1.5 MB | ||||
| # rotate up to N log files when the current one gets too big | # rotate up to N log files when the current one gets too big | ||||
| maxfiles = 3 | maxfiles = 3 | ||||
| [blackbox] | [blackbox] | ||||
| # Include nanoseconds in log entries with %f (see Python function | # Include nanoseconds in log entries with %f (see Python function | ||||
| # datetime.datetime.strftime) | # datetime.datetime.strftime) | ||||
| default=False, | default=False, | ||||
| ) | ) | ||||
| configitem('blackbox', 'maxfiles', | configitem('blackbox', 'maxfiles', | ||||
| default=7, | default=7, | ||||
| ) | ) | ||||
| configitem('blackbox', 'track', | configitem('blackbox', 'track', | ||||
| default=lambda: ['*'], | default=lambda: ['*'], | ||||
| ) | ) | ||||
| configitem('blackbox', 'notrack', | |||||
| default=lambda: [], | |||||
| ) | |||||
| configitem('blackbox', 'date-format', | configitem('blackbox', 'date-format', | ||||
| default='%Y/%m/%d %H:%M:%S', | default='%Y/%m/%d %H:%M:%S', | ||||
| ) | ) | ||||
| _lastlogger = loggingutil.proxylogger() | _lastlogger = loggingutil.proxylogger() | ||||
| class blackboxlogger(object): | class blackboxlogger(object): | ||||
| def __init__(self, ui, repo): | def __init__(self, ui, repo): | ||||
| self._repo = repo | self._repo = repo | ||||
| self._active = True | self._active = True | ||||
| track = ui.configlist('blackbox', 'track') | track = ui.configlist('blackbox', 'track') | ||||
| if not track: | if not track: | ||||
| self._active = False | self._active = False | ||||
| elif b'*' in track: | elif b'*' in track: | ||||
| self._trackedevents = re.compile(b'.*') | self._trackedevents = re.compile(b'.*') | ||||
| else: | else: | ||||
| try: | try: | ||||
| self._trackedevents = re.compile(b'|'.join(track)) | self._trackedevents = re.compile(b'|'.join(track)) | ||||
| except re.error as e: | except re.error as e: | ||||
| ui.warn(_('invalid blackbox.track setting: %s\n') % e) | ui.warn(_('invalid blackbox.track setting: %s\n') % e) | ||||
| self._active = False | self._active = False | ||||
| self._notrackedevents = None | |||||
| notrack = ui.configlist('blackbox', 'notrack') | |||||
| if notrack: # re.compile('').match matches *everything* | |||||
| try: | |||||
| self._notrackedevents = re.compile(br'|'.join(notrack)) | |||||
| except re.error as e: | |||||
| # logging too much is usually less of a problem, so we just | |||||
| # (mostly) silently accept this. | |||||
| ui.debug('invalid blackbox.notrack setting: %s\n' % e) | |||||
| self._maxfiles = ui.configint('blackbox', 'maxfiles') | self._maxfiles = ui.configint('blackbox', 'maxfiles') | ||||
| self._maxsize = ui.configbytes('blackbox', 'maxsize') | self._maxsize = ui.configbytes('blackbox', 'maxsize') | ||||
| self._inlog = False | self._inlog = False | ||||
| def tracked(self, event): | def tracked(self, event): | ||||
| return self._active and self._trackedevents.match(event) | return (self._active and | ||||
| (not self._notrackedevents or | |||||
| not self._notrackedevents.match(event)) and | |||||
| self._trackedevents.match(event)) | |||||
| def log(self, ui, event, msg, opts): | def log(self, ui, event, msg, opts): | ||||
| # self._log() -> ctx.dirty() may create new subrepo instance, which | # self._log() -> ctx.dirty() may create new subrepo instance, which | ||||
| # ui is derived from baseui. So the recursion guard in ui.log() | # ui is derived from baseui. So the recursion guard in ui.log() | ||||
| # doesn't work as it's local to the ui instance. | # doesn't work as it's local to the ui instance. | ||||
| if self._inlog: | if self._inlog: | ||||
| return | return | ||||
| self._inlog = True | self._inlog = True | ||||
| $ cat >> .hg/hgrc << EOF | $ cat >> .hg/hgrc << EOF | ||||
| > [blackbox] | > [blackbox] | ||||
| > track = ** | > track = ** | ||||
| > EOF | > EOF | ||||
| $ hg blackbox | $ hg blackbox | ||||
| invalid blackbox.track setting: nothing to repeat | invalid blackbox.track setting: nothing to repeat | ||||
| $ cd $TESTTMP | $ cd $TESTTMP | ||||
| test blackbox.notrack setting | |||||
| (test that setting this on the commandline works, and doesn't record the 'init' | |||||
| command) | |||||
| $ hg --config blackbox.track='*' \ | |||||
| > --config blackbox.notrack='.*' \ | |||||
| > init test_notrack | |||||
| $ cd test_notrack | |||||
| $ cat >> .hg/hgrc << EOF | |||||
| > [blackbox] | |||||
| > logsource = True | |||||
| > # a rather odd way of writing 'track = command' :) | |||||
| > track = command.* | |||||
| > notrack = comand..* | |||||
| > EOF | |||||
| (this should only have 'command', and not have 'commandfinish' or others) | |||||
| $ hg blackbox | |||||
| 1970/01/01 00:00:00 bob @0000000000000000000000000000000000000000 (5000) [command]> blackbox | |||||
| $ cd $TESTTMP | |||||
| invalid regex entries in blackbox.notrack cause it to be silently ignored | |||||
| $ hg --config blackbox.track='command.*' \ | |||||
| > --config blackbox.notrack=')' \ | |||||
| > init test_notrack_invalid | |||||
| $ cd test_notrack_invalid | |||||
| $ cat >> .hg/hgrc << EOF | |||||
| > [blackbox] | |||||
| > logsource = True | |||||
| > track = command.* | |||||
| > # invalid: "nothing to repeat" | |||||
| > notrack = comand..** | |||||
| > [alias] | |||||
| > blackboxalias = blackbox | |||||
| > EOF | |||||
| $ hg blackboxalias | |||||
| 1970/01/01 00:00:00 bob @0000000000000000000000000000000000000000 (5000)> --config 'blackbox.track=command.*' --config 'blackbox.notrack=)' init test_notrack_invalid exited 0 after * seconds (glob) | |||||
| 1970/01/01 00:00:00 bob @0000000000000000000000000000000000000000 (5000) [command]> blackboxalias | |||||
| 1970/01/01 00:00:00 bob @0000000000000000000000000000000000000000 (5000) [commandalias]> alias 'blackboxalias' expands to 'blackbox' | |||||
| $ cd $TESTTMP | |||||
| #if chg | #if chg | ||||
| when using chg, blackbox.log should get rotated correctly | when using chg, blackbox.log should get rotated correctly | ||||
| $ cat > $TESTTMP/noop.py << EOF | $ cat > $TESTTMP/noop.py << EOF | ||||
| > from __future__ import absolute_import | > from __future__ import absolute_import | ||||
| > import time | > import time | ||||
| > from mercurial import registrar, scmutil | > from mercurial import registrar, scmutil | ||||