35
# TODO: in debug mode, stderr should get full tracebacks and also
36
# debug messages. (Is this really needed?)
38
49
# FIXME: Unfortunately it turns out that python's logging module
39
50
# is quite expensive, even when the message is not printed by any handlers.
40
51
# We should perhaps change back to just simply doing it here.
53
# On the other hand, as of 1.2 we generally only call the mutter() statement
54
# if (according to debug_flags) we actually intend to write it. So the
55
# increased cost of logging.py is not so bad, and we could standardize on
65
from bzrlib.lazy_import import lazy_import
66
lazy_import(globals(), """
67
from cStringIO import StringIO
48
from bzrlib.errors import BzrError, BzrNewError
52
_stderr_handler = None
75
lazy_import(globals(), """
86
# global verbosity for bzrlib; controls the log level for stderr; 0=normal; <0
87
# is quiet; >0 is verbose.
90
# File-like object where mutter/debug output is currently sent. Can be
91
# changed by _push_log_file etc. This is directly manipulated by some
92
# external code; maybe there should be functions to do that more precisely
93
# than push/pop_log_file.
59
class QuietFormatter(logging.Formatter):
60
"""Formatter that suppresses the details of errors.
62
This is used by default on stderr so as not to scare the user.
64
# At first I tried overriding FormatException to suppress the
65
# exception details, but that has global effect: no loggers
66
# can get the exception details is we suppress them here.
68
def format(self, record):
69
if record.levelno >= logging.WARNING:
70
s = 'bzr: ' + record.levelname + ': '
73
s += record.getMessage()
75
s += '\n' + format_exception_short(record.exc_info)
78
# configure convenient aliases for output routines
96
# Absolute path for ~/.bzr.log. Not changed even if the log/trace output is
97
# redirected elsewhere. Used to show the location in --version.
98
_bzr_log_filename = None
100
# The time the first message was written to the trace file, so that we can
101
# show relative times since startup.
102
_bzr_log_start_time = bzrlib._start_time
105
# held in a global for quick reference
80
106
_bzr_logger = logging.getLogger('bzr')
82
109
def note(*args, **kwargs):
110
# FIXME note always emits utf-8, regardless of the terminal encoding
112
# FIXME: clearing the ui and then going through the abstract logging
113
# framework is whack; we should probably have a logging Handler that
114
# deals with terminal output if needed.
84
116
bzrlib.ui.ui_factory.clear_term()
85
117
_bzr_logger.info(*args, **kwargs)
87
120
def warning(*args, **kwargs):
89
122
bzrlib.ui.ui_factory.clear_term()
90
123
_bzr_logger.warning(*args, **kwargs)
126
# configure convenient aliases for output routines
128
# TODO: deprecate them, have one name for each.
93
130
log_error = _bzr_logger.error
94
131
error = _bzr_logger.error
97
134
def mutter(fmt, *args):
98
135
if _trace_file is None:
100
if hasattr(_trace_file, 'closed') and _trace_file.closed:
137
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
140
if isinstance(fmt, unicode):
141
fmt = fmt.encode('utf8')
102
143
if len(args) > 0:
103
144
# It seems that if we do ascii % (unicode, ascii) we can
104
145
# get a unicode cannot encode ascii error, so make sure that "fmt"
105
146
# is a unicode string
106
out = unicode(fmt) % args
149
if isinstance(arg, unicode):
150
arg = arg.encode('utf8')
151
real_args.append(arg)
152
out = fmt % tuple(real_args)
111
_trace_file.write(out)
112
except UnicodeError, e:
113
warning('UnicodeError: %s', e)
114
_trace_file.write(repr(out))
115
# TODO: jam 20051227 Consider flushing the trace file to help debugging
155
timestamp = '%0.3f ' % (time.time() - _bzr_log_start_time,)
156
out = timestamp + out + '\n'
157
_trace_file.write(out)
158
# no need to flush here, the trace file is now linebuffered when it's
162
def mutter_callsite(stacklevel, fmt, *args):
163
"""Perform a mutter of fmt and args, logging the call trace.
165
:param stacklevel: The number of frames to show. None will show all
167
:param fmt: The format string to pass to mutter.
168
:param args: A list of substitution variables.
171
if stacklevel is None:
174
limit = stacklevel + 1
175
traceback.print_stack(limit=limit, file=outf)
176
formatted_lines = outf.getvalue().splitlines()
177
formatted_stack = '\n'.join(formatted_lines[:-2])
178
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
120
181
def _rollover_trace_maybe(trace_fname):
124
185
if size <= 4 << 20:
126
187
old_fname = trace_fname + '.old'
127
from osutils import rename
128
rename(trace_fname, old_fname)
188
osutils.rename(trace_fname, old_fname)
133
def open_tracefile(tracefilename='~/.bzr.log'):
134
# Messages are always written to here, so that we have some
135
# information if something goes wrong. In a future version this
136
# file will be removed on successful completion.
137
global _file_handler, _bzr_log_file
140
trace_fname = os.path.join(os.path.expanduser(tracefilename))
141
_rollover_trace_maybe(trace_fname)
193
def _get_bzr_log_filename():
194
bzr_log = os.environ.get('BZR_LOG')
197
home = os.environ.get('BZR_HOME')
199
if sys.platform == 'win32':
200
from bzrlib import win32utils
201
home = win32utils.get_home_location()
203
home = os.path.expanduser('~')
204
return os.path.join(home, '.bzr.log')
208
"""Open the .bzr.log trace file.
210
If the log is more than a particular length, the old file is renamed to
211
.bzr.log.old and a new file is started. Otherwise, we append to the
214
This sets the global _bzr_log_filename.
216
global _bzr_log_filename
217
_bzr_log_filename = _get_bzr_log_filename()
218
_rollover_trace_maybe(_bzr_log_filename)
144
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
147
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
148
tf.write("you can delete or truncate this file, or include sections in\n")
149
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
150
_file_handler = logging.StreamHandler(tf)
151
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
152
datefmt = r'%a %H:%M:%S'
153
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
154
_file_handler.setLevel(logging.DEBUG)
155
logging.getLogger('').addHandler(_file_handler)
220
bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
221
# bzr_log_file.tell() on windows always return 0 until some writing done
222
bzr_log_file.write('\n')
223
if bzr_log_file.tell() <= 2:
224
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
225
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
226
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
156
228
except IOError, e:
157
229
warning("failed to open trace file: %s" % (e))
160
def log_startup(argv):
161
debug('\n\nbzr %s invoked on python %s (%s)',
163
'.'.join(map(str, sys.version_info)),
165
debug(' arguments: %r', argv)
166
debug(' working dir: %r', os.getcwdu())
169
def log_exception(msg=None):
170
"""Log the last exception to stderr and the trace file.
172
The exception string representation is used as the error
173
summary, unless msg is given.
178
exc_str = format_exception_short(sys.exc_info())
180
log_exception_quietly()
230
# TODO: What should happen if we fail to open the trace file? Maybe the
231
# objects should be pointed at /dev/null or the equivalent? Currently
232
# returns None which will cause failures later.
235
def enable_default_logging():
236
"""Configure default logging: messages to stderr and debug to .bzr.log
238
This should only be called once per process.
240
Non-command-line programs embedding bzrlib do not need to call this. They
241
can instead either pass a file to _push_log_file, or act directly on
242
logging.getLogger("bzr").
244
Output can be redirected away by calling _push_log_file.
246
# create encoded wrapper around stderr
247
bzr_log_file = _open_bzr_log()
248
push_log_file(bzr_log_file,
249
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
250
r'%Y-%m-%d %H:%M:%S')
251
# after hooking output into bzr_log, we also need to attach a stderr
252
# handler, writing only at level info and with encoding
253
writer_factory = codecs.getwriter(osutils.get_terminal_encoding())
254
encoded_stderr = writer_factory(sys.stderr, errors='replace')
255
stderr_handler = logging.StreamHandler(encoded_stderr)
256
stderr_handler.setLevel(logging.INFO)
257
logging.getLogger('bzr').addHandler(stderr_handler)
260
def push_log_file(to_file, log_format=None, date_format=None):
261
"""Intercept log and trace messages and send them to a file.
263
:param to_file: A file-like object to which messages will be sent.
265
:returns: A memento that should be passed to _pop_log_file to restore the
266
previously active logging.
270
new_handler = logging.StreamHandler(to_file)
271
new_handler.setLevel(logging.DEBUG)
272
if log_format is None:
273
log_format = '%(levelname)8s %(message)s'
274
new_handler.setFormatter(logging.Formatter(log_format, date_format))
275
# save and remove any existing log handlers
276
bzr_logger = logging.getLogger('bzr')
277
old_handlers = bzr_logger.handlers[:]
278
del bzr_logger.handlers[:]
279
# set that as the default logger
280
bzr_logger.addHandler(new_handler)
281
bzr_logger.setLevel(logging.DEBUG)
282
# TODO: check if any changes are needed to the root logger
284
# TODO: also probably need to save and restore the level on bzr_logger.
285
# but maybe we can avoid setting the logger level altogether, and just set
286
# the level on the handler?
288
# save the old trace file
289
old_trace_file = _trace_file
290
# send traces to the new one
291
_trace_file = to_file
292
result = new_handler, _trace_file
293
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
296
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
297
"""Undo changes to logging/tracing done by _push_log_file.
299
This flushes, but does not close the trace file.
301
Takes the memento returned from _push_log_file."""
303
_trace_file = old_trace_file
304
bzr_logger = logging.getLogger('bzr')
305
bzr_logger.removeHandler(new_handler)
306
# must be closed, otherwise logging will try to close it atexit, and the
307
# file will likely already be closed underneath.
309
bzr_logger.handlers = old_handlers
310
new_trace_file.flush()
313
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
314
def enable_test_log(to_file):
315
"""Redirect logging to a temporary file for a test
317
:returns: an opaque reference that should be passed to disable_test_log
318
after the test completes.
320
return push_log_file(to_file)
323
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
324
def disable_test_log(memento):
325
return pop_log_file(memento)
183
328
def log_exception_quietly():
187
332
interesting to developers but not to users. For example,
188
333
errors loading plugins.
191
debug(traceback.format_exc())
194
def enable_default_logging():
195
"""Configure default logging to stderr and .bzr.log"""
196
# FIXME: if this is run twice, things get confused
197
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
198
_stderr_handler = logging.StreamHandler()
199
_stderr_handler.setFormatter(QuietFormatter())
200
logging.getLogger('').addHandler(_stderr_handler)
201
_stderr_handler.setLevel(logging.INFO)
202
if not _file_handler:
204
_trace_file = _bzr_log_file
206
_file_handler.setLevel(logging.DEBUG)
207
_bzr_logger.setLevel(logging.DEBUG)
335
mutter(traceback.format_exc())
338
def set_verbosity_level(level):
339
"""Set the verbosity level.
341
:param level: -ve for quiet, 0 for normal, +ve for verbose
343
global _verbosity_level
344
_verbosity_level = level
345
_update_logging_level(level < 0)
348
def get_verbosity_level():
349
"""Get the verbosity level.
351
See set_verbosity_level() for values.
353
return _verbosity_level
211
356
def be_quiet(quiet=True):
212
global _stderr_handler, _stderr_quiet
214
_stderr_quiet = quiet
216
_stderr_handler.setLevel(logging.WARNING)
218
_stderr_handler.setLevel(logging.INFO)
357
# Perhaps this could be deprecated now ...
359
set_verbosity_level(-1)
361
set_verbosity_level(0)
364
def _update_logging_level(quiet=True):
365
"""Hide INFO messages if quiet."""
367
_bzr_logger.setLevel(logging.WARNING)
369
_bzr_logger.setLevel(logging.INFO)
373
"""Is the verbosity level negative?"""
374
return _verbosity_level < 0
378
"""Is the verbosity level positive?"""
379
return _verbosity_level > 0
382
@symbol_versioning.deprecated_function(symbol_versioning.one_two)
226
383
def disable_default_logging():
227
384
"""Turn off default log handlers.
229
This is intended to be used by the test framework, which doesn't
230
want leakage from the code-under-test into the main logs.
233
l = logging.getLogger('')
234
l.removeHandler(_stderr_handler)
236
l.removeHandler(_file_handler)
240
def enable_test_log(to_file):
241
"""Redirect logging to a temporary file for a test
243
returns an opaque reference that should be passed to disable_test_log
244
after the test completes.
246
disable_default_logging()
249
hdlr = logging.StreamHandler(to_file)
250
hdlr.setLevel(logging.DEBUG)
251
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
252
_bzr_logger.addHandler(hdlr)
253
_bzr_logger.setLevel(logging.DEBUG)
254
result = hdlr, _trace_file, _trace_depth
255
_trace_file = to_file
260
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
261
_bzr_logger.removeHandler(test_log_hdlr)
262
test_log_hdlr.close()
265
_trace_file = old_trace_file
266
_trace_depth = old_trace_depth
268
enable_default_logging()
271
def format_exception_short(exc_info):
272
"""Make a short string form of an exception.
274
This is used for display to stderr. It specially handles exception
275
classes without useful string methods.
277
The result has no trailing newline.
279
exc_info - typically an exception from sys.exc_info()
281
exc_type, exc_object, exc_tb = exc_info
284
return '(no exception)'
285
if isinstance(exc_object, (BzrError, BzrNewError)):
286
return str(exc_object)
289
tb = traceback.extract_tb(exc_tb)
290
msg = '%s: %s' % (exc_type, exc_object)
294
msg += '\n at %s line %d\n in %s' % (tb[-1][:3])
296
except Exception, formatting_exc:
297
# XXX: is this really better than just letting it run up?
298
return '(error formatting exception of type %s: %s)' \
299
% (exc_type, formatting_exc)
386
Don't call this method, use _push_log_file and _pop_log_file instead.
391
def report_exception(exc_info, err_file):
392
"""Report an exception to err_file (typically stderr) and to .bzr.log.
394
This will show either a full traceback or a short message as appropriate.
396
:return: The appropriate exit code for this error.
398
exc_type, exc_object, exc_tb = exc_info
399
# Log the full traceback to ~/.bzr.log
400
log_exception_quietly()
401
if (isinstance(exc_object, IOError)
402
and getattr(exc_object, 'errno', None) == errno.EPIPE):
403
err_file.write("bzr: broken pipe\n")
404
return errors.EXIT_ERROR
405
elif isinstance(exc_object, KeyboardInterrupt):
406
err_file.write("bzr: interrupted\n")
407
return errors.EXIT_ERROR
408
elif isinstance(exc_object, ImportError) \
409
and str(exc_object).startswith("No module named "):
410
report_user_error(exc_info, err_file,
411
'You may need to install this Python library separately.')
412
return errors.EXIT_ERROR
413
elif not getattr(exc_object, 'internal_error', True):
414
report_user_error(exc_info, err_file)
415
return errors.EXIT_ERROR
416
elif isinstance(exc_object, (OSError, IOError)):
417
# Might be nice to catch all of these and show them as something more
418
# specific, but there are too many cases at the moment.
419
report_user_error(exc_info, err_file)
420
return errors.EXIT_ERROR
422
report_bug(exc_info, err_file)
423
return errors.EXIT_INTERNAL_ERROR
426
def print_exception(exc_info, err_file):
427
exc_type, exc_object, exc_tb = exc_info
428
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
429
exc_type.__module__, exc_type.__name__, exc_object))
431
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
434
# TODO: Should these be specially encoding the output?
435
def report_user_error(exc_info, err_file, advice=None):
436
"""Report to err_file an error that's not an internal error.
438
These don't get a traceback unless -Derror was given.
440
:param exc_info: 3-tuple from sys.exc_info()
441
:param advice: Extra advice to the user to be printed following the
444
if 'error' in debug.debug_flags:
445
print_exception(exc_info, err_file)
447
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
449
err_file.write("%s\n" % (advice,))
452
def report_bug(exc_info, err_file):
453
"""Report an exception that probably indicates a bug in bzr"""
454
print_exception(exc_info, err_file)
456
err_file.write('bzr %s on python %s (%s)\n' % \
458
bzrlib._format_version_tuple(sys.version_info),
460
err_file.write('arguments: %r\n' % sys.argv)
462
'encoding: %r, fsenc: %r, lang: %r\n' % (
463
osutils.get_user_encoding(), sys.getfilesystemencoding(),
464
os.environ.get('LANG')))
465
err_file.write("plugins:\n")
466
for name, a_plugin in sorted(plugin.plugins().items()):
467
err_file.write(" %-20s %s [%s]\n" %
468
(name, a_plugin.path(), a_plugin.__version__))
471
*** Bazaar has encountered an internal error.
472
Please report a bug at https://bugs.launchpad.net/bzr/+filebug
473
including this traceback, and a description of what you
474
were doing when the error occurred.
added
removed
bzrlib/trace.py
