Show More
@@ -1,229 +1,230 b'' | |||
|
1 | 1 | # blackbox.py - log repository events to a file for post-mortem debugging |
|
2 | 2 | # |
|
3 | 3 | # Copyright 2010 Nicolas Dumazet |
|
4 | 4 | # Copyright 2013 Facebook, Inc. |
|
5 | 5 | # |
|
6 | 6 | # This software may be used and distributed according to the terms of the |
|
7 | 7 | # GNU General Public License version 2 or any later version. |
|
8 | 8 | |
|
9 | 9 | """log repository events to a blackbox for debugging |
|
10 | 10 | |
|
11 | 11 | Logs event information to .hg/blackbox.log to help debug and diagnose problems. |
|
12 | 12 | The events that get logged can be configured via the blackbox.track config key. |
|
13 | 13 | |
|
14 | 14 | Examples:: |
|
15 | 15 | |
|
16 | 16 | [blackbox] |
|
17 | 17 | track = * |
|
18 | 18 | # dirty is *EXPENSIVE* (slow); |
|
19 | 19 | # each log entry indicates `+` if the repository is dirty, like :hg:`id`. |
|
20 | 20 | dirty = True |
|
21 | 21 | # record the source of log messages |
|
22 | 22 | logsource = True |
|
23 | 23 | |
|
24 | 24 | [blackbox] |
|
25 | 25 | track = command, commandfinish, commandexception, exthook, pythonhook |
|
26 | 26 | |
|
27 | 27 | [blackbox] |
|
28 | 28 | track = incoming |
|
29 | 29 | |
|
30 | 30 | [blackbox] |
|
31 | 31 | # limit the size of a log file |
|
32 | 32 | maxsize = 1.5 MB |
|
33 | 33 | # rotate up to N log files when the current one gets too big |
|
34 | 34 | maxfiles = 3 |
|
35 | 35 | |
|
36 | 36 | [blackbox] |
|
37 | 37 | # Include nanoseconds in log entries with %f (see Python function |
|
38 | 38 | # datetime.datetime.strftime) |
|
39 | 39 | date-format = '%Y-%m-%d @ %H:%M:%S.%f' |
|
40 | 40 | |
|
41 | 41 | """ |
|
42 | 42 | |
|
43 | 43 | from __future__ import absolute_import |
|
44 | 44 | |
|
45 | 45 | import errno |
|
46 | 46 | import re |
|
47 | 47 | |
|
48 | 48 | from mercurial.i18n import _ |
|
49 | 49 | from mercurial.node import hex |
|
50 | 50 | |
|
51 | 51 | from mercurial import ( |
|
52 | 52 | encoding, |
|
53 | 53 | pycompat, |
|
54 | 54 | registrar, |
|
55 | 55 | ) |
|
56 | 56 | from mercurial.utils import ( |
|
57 | 57 | dateutil, |
|
58 | 58 | procutil, |
|
59 | 59 | ) |
|
60 | 60 | |
|
61 | 61 | # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for |
|
62 | 62 | # extensions which SHIP WITH MERCURIAL. Non-mainline extensions should |
|
63 | 63 | # be specifying the version(s) of Mercurial they are tested with, or |
|
64 | 64 | # leave the attribute unspecified. |
|
65 | 65 | testedwith = 'ships-with-hg-core' |
|
66 | 66 | |
|
67 | 67 | cmdtable = {} |
|
68 | 68 | command = registrar.command(cmdtable) |
|
69 | 69 | |
|
70 | 70 | configtable = {} |
|
71 | 71 | configitem = registrar.configitem(configtable) |
|
72 | 72 | |
|
73 | 73 | configitem('blackbox', 'dirty', |
|
74 | 74 | default=False, |
|
75 | 75 | ) |
|
76 | 76 | configitem('blackbox', 'maxsize', |
|
77 | 77 | default='1 MB', |
|
78 | 78 | ) |
|
79 | 79 | configitem('blackbox', 'logsource', |
|
80 | 80 | default=False, |
|
81 | 81 | ) |
|
82 | 82 | configitem('blackbox', 'maxfiles', |
|
83 | 83 | default=7, |
|
84 | 84 | ) |
|
85 | 85 | configitem('blackbox', 'track', |
|
86 | 86 | default=lambda: ['*'], |
|
87 | 87 | ) |
|
88 | 88 | configitem('blackbox', 'date-format', |
|
89 | 89 | default='%Y/%m/%d %H:%M:%S', |
|
90 | 90 | ) |
|
91 | 91 | |
|
92 | def _openlogfile(ui, vfs): | |
|
92 | def _openlogfile(ui, vfs, name, maxfiles=0, maxsize=0): | |
|
93 | 93 | def rotate(oldpath, newpath): |
|
94 | 94 | try: |
|
95 | 95 | vfs.unlink(newpath) |
|
96 | 96 | except OSError as err: |
|
97 | 97 | if err.errno != errno.ENOENT: |
|
98 | 98 | ui.debug("warning: cannot remove '%s': %s\n" % |
|
99 | 99 | (newpath, err.strerror)) |
|
100 | 100 | try: |
|
101 | 101 | if newpath: |
|
102 | 102 | vfs.rename(oldpath, newpath) |
|
103 | 103 | except OSError as err: |
|
104 | 104 | if err.errno != errno.ENOENT: |
|
105 | 105 | ui.debug("warning: cannot rename '%s' to '%s': %s\n" % |
|
106 | 106 | (newpath, oldpath, err.strerror)) |
|
107 | 107 | |
|
108 | maxsize = ui.configbytes('blackbox', 'maxsize') | |
|
109 | name = 'blackbox.log' | |
|
110 | 108 | if maxsize > 0: |
|
111 | 109 | try: |
|
112 | 110 | st = vfs.stat(name) |
|
113 | 111 | except OSError: |
|
114 | 112 | pass |
|
115 | 113 | else: |
|
116 | 114 | if st.st_size >= maxsize: |
|
117 | 115 | path = vfs.join(name) |
|
118 | maxfiles = ui.configint('blackbox', 'maxfiles') | |
|
119 | 116 | for i in pycompat.xrange(maxfiles - 1, 1, -1): |
|
120 | 117 | rotate(oldpath='%s.%d' % (path, i - 1), |
|
121 | 118 | newpath='%s.%d' % (path, i)) |
|
122 | 119 | rotate(oldpath=path, |
|
123 | 120 | newpath=maxfiles > 0 and path + '.1') |
|
124 | 121 | return vfs(name, 'a', makeparentdirs=False) |
|
125 | 122 | |
|
126 | 123 | class proxylogger(object): |
|
127 | 124 | """Forward log events to another logger to be set later""" |
|
128 | 125 | |
|
129 | 126 | def __init__(self): |
|
130 | 127 | self.logger = None |
|
131 | 128 | |
|
132 | 129 | def tracked(self, event): |
|
133 | 130 | return self.logger is not None and self.logger.tracked(event) |
|
134 | 131 | |
|
135 | 132 | def log(self, ui, event, msg, opts): |
|
136 | 133 | assert self.logger is not None |
|
137 | 134 | self.logger.log(ui, event, msg, opts) |
|
138 | 135 | |
|
139 | 136 | _lastlogger = proxylogger() |
|
140 | 137 | |
|
141 | 138 | class blackboxlogger(object): |
|
142 | 139 | def __init__(self, ui, repo): |
|
143 | 140 | self._repo = repo |
|
144 | 141 | self._trackedevents = set(ui.configlist('blackbox', 'track')) |
|
142 | self._maxfiles = ui.configint('blackbox', 'maxfiles') | |
|
143 | self._maxsize = ui.configbytes('blackbox', 'maxsize') | |
|
145 | 144 | |
|
146 | 145 | def tracked(self, event): |
|
147 | 146 | return b'*' in self._trackedevents or event in self._trackedevents |
|
148 | 147 | |
|
149 | 148 | def log(self, ui, event, msg, opts): |
|
150 | 149 | default = ui.configdate('devel', 'default-date') |
|
151 | 150 | date = dateutil.datestr(default, ui.config('blackbox', 'date-format')) |
|
152 | 151 | user = procutil.getuser() |
|
153 | 152 | pid = '%d' % procutil.getpid() |
|
154 | 153 | rev = '(unknown)' |
|
155 | 154 | changed = '' |
|
156 | 155 | ctx = self._repo[None] |
|
157 | 156 | parents = ctx.parents() |
|
158 | 157 | rev = ('+'.join([hex(p.node()) for p in parents])) |
|
159 | 158 | if (ui.configbool('blackbox', 'dirty') and |
|
160 | 159 | ctx.dirty(missing=True, merge=False, branch=False)): |
|
161 | 160 | changed = '+' |
|
162 | 161 | if ui.configbool('blackbox', 'logsource'): |
|
163 | 162 | src = ' [%s]' % event |
|
164 | 163 | else: |
|
165 | 164 | src = '' |
|
166 | 165 | try: |
|
167 | 166 | fmt = '%s %s @%s%s (%s)%s> %s' |
|
168 | 167 | args = (date, user, rev, changed, pid, src, msg) |
|
169 |
with _openlogfile(ui, self._repo.vfs |
|
|
168 | with _openlogfile(ui, self._repo.vfs, name='blackbox.log', | |
|
169 | maxfiles=self._maxfiles, | |
|
170 | maxsize=self._maxsize) as fp: | |
|
170 | 171 | fp.write(fmt % args) |
|
171 | 172 | except (IOError, OSError) as err: |
|
172 | 173 | # deactivate this to avoid failed logging again |
|
173 | 174 | self._trackedevents.clear() |
|
174 | 175 | ui.debug('warning: cannot write to blackbox.log: %s\n' % |
|
175 | 176 | encoding.strtolocal(err.strerror)) |
|
176 | 177 | return |
|
177 | 178 | _lastlogger.logger = self |
|
178 | 179 | |
|
179 | 180 | def uipopulate(ui): |
|
180 | 181 | ui.setlogger(b'blackbox', _lastlogger) |
|
181 | 182 | |
|
182 | 183 | def reposetup(ui, repo): |
|
183 | 184 | # During 'hg pull' a httppeer repo is created to represent the remote repo. |
|
184 | 185 | # It doesn't have a .hg directory to put a blackbox in, so we don't do |
|
185 | 186 | # the blackbox setup for it. |
|
186 | 187 | if not repo.local(): |
|
187 | 188 | return |
|
188 | 189 | |
|
189 | 190 | # Since blackbox.log is stored in the repo directory, the logger should be |
|
190 | 191 | # instantiated per repository. |
|
191 | 192 | logger = blackboxlogger(ui, repo) |
|
192 | 193 | ui.setlogger(b'blackbox', logger) |
|
193 | 194 | |
|
194 | 195 | # Set _lastlogger even if ui.log is not called. This gives blackbox a |
|
195 | 196 | # fallback place to log |
|
196 | 197 | if _lastlogger.logger is None: |
|
197 | 198 | _lastlogger.logger = logger |
|
198 | 199 | |
|
199 | 200 | repo._wlockfreeprefix.add('blackbox.log') |
|
200 | 201 | |
|
201 | 202 | @command('blackbox', |
|
202 | 203 | [('l', 'limit', 10, _('the number of events to show')), |
|
203 | 204 | ], |
|
204 | 205 | _('hg blackbox [OPTION]...'), |
|
205 | 206 | helpcategory=command.CATEGORY_MAINTENANCE, |
|
206 | 207 | helpbasic=True) |
|
207 | 208 | def blackbox(ui, repo, *revs, **opts): |
|
208 | 209 | '''view the recent repository events |
|
209 | 210 | ''' |
|
210 | 211 | |
|
211 | 212 | if not repo.vfs.exists('blackbox.log'): |
|
212 | 213 | return |
|
213 | 214 | |
|
214 | 215 | limit = opts.get(r'limit') |
|
215 | 216 | fp = repo.vfs('blackbox.log', 'r') |
|
216 | 217 | lines = fp.read().split('\n') |
|
217 | 218 | |
|
218 | 219 | count = 0 |
|
219 | 220 | output = [] |
|
220 | 221 | for line in reversed(lines): |
|
221 | 222 | if count >= limit: |
|
222 | 223 | break |
|
223 | 224 | |
|
224 | 225 | # count the commands by matching lines like: 2013/01/23 19:13:36 root> |
|
225 | 226 | if re.match('^\d{4}/\d{2}/\d{2} \d{2}:\d{2}:\d{2} .*> .*', line): |
|
226 | 227 | count += 1 |
|
227 | 228 | output.append(line) |
|
228 | 229 | |
|
229 | 230 | ui.status('\n'.join(reversed(output))) |
General Comments 0
You need to be logged in to leave comments.
Login now