20
34
Output to stderr depends on the mode chosen by the user. By default, messages
21
35
of info and above are sent out, which results in progress messages such as the
22
list of files processed by add and commit. In quiet mode, only warnings and
23
above are shown. In debug mode, stderr gets debug messages too.
36
list of files processed by add and commit. In debug mode, stderr gets debug messages too.
25
38
Errors that terminate an operation are generally passed back as exceptions;
26
39
others may be just emitted as messages.
28
41
Exceptions are reported in a brief form to stderr so as not to look scary.
29
42
BzrErrors are required to be able to format themselves into a properly
30
explanatory message. This is not true for builtin excexceptions such as
43
explanatory message. This is not true for builtin exceptions such as
31
44
KeyError, which typically just str to "0". They're printed in a different
35
# TODO: in debug mode, stderr should get full tracebacks and also
36
# debug messages. (Is this really needed?)
38
48
# FIXME: Unfortunately it turns out that python's logging module
39
49
# is quite expensive, even when the message is not printed by any handlers.
40
50
# We should perhaps change back to just simply doing it here.
52
# On the other hand, as of 1.2 we generally only call the mutter() statement
53
# if (according to debug_flags) we actually intend to write it. So the
54
# increased cost of logging.py is not so bad, and we could standardize on
63
from bzrlib.lazy_import import lazy_import
64
lazy_import(globals(), """
65
from cStringIO import StringIO
48
from bzrlib.errors import BzrError, BzrNewError
52
_stderr_handler = None
74
lazy_import(globals(), """
84
# global verbosity for bzrlib; controls the log level for stderr; 0=normal; <0
85
# is quiet; >0 is verbose.
88
# File-like object where mutter/debug output is currently sent. Can be
89
# changed by _push_log_file etc. This is directly manipulated by some
90
# external code; maybe there should be functions to do that more precisely
91
# than push/pop_log_file.
59
class QuietFormatter(logging.Formatter):
60
"""Formatter that supresses 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
94
# Absolute path for ~/.bzr.log. Not changed even if the log/trace output is
95
# redirected elsewhere. Used to show the location in --version.
96
_bzr_log_filename = None
98
# The time the first message was written to the trace file, so that we can
99
# show relative times since startup.
100
_bzr_log_start_time = bzrlib._start_time
103
# held in a global for quick reference
80
104
_bzr_logger = logging.getLogger('bzr')
82
107
def note(*args, **kwargs):
84
bzrlib.ui.ui_factory.clear_term()
108
"""Output a note to the user.
110
Takes the same parameters as logging.info.
114
# FIXME note always emits utf-8, regardless of the terminal encoding
116
# FIXME: clearing the ui and then going through the abstract logging
117
# framework is whack; we should probably have a logging Handler that
118
# deals with terminal output if needed.
119
ui.ui_factory.clear_term()
85
120
_bzr_logger.info(*args, **kwargs)
87
123
def warning(*args, **kwargs):
89
bzrlib.ui.ui_factory.clear_term()
124
ui.ui_factory.clear_term()
90
125
_bzr_logger.warning(*args, **kwargs)
93
log_error = _bzr_logger.error
94
error = _bzr_logger.error
128
def show_error(*args, **kwargs):
129
"""Show an error message to the user.
131
Don't use this for exceptions, use report_exception instead.
133
_bzr_logger.error(*args, **kwargs)
97
136
def mutter(fmt, *args):
98
137
if _trace_file is None:
100
if hasattr(_trace_file, 'closed') and _trace_file.closed:
139
# XXX: Don't check this every time; instead anyone who closes the file
140
# ought to deregister it. We can tolerate None.
141
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
144
if isinstance(fmt, unicode):
145
fmt = fmt.encode('utf8')
102
147
if len(args) > 0:
103
148
# It seems that if we do ascii % (unicode, ascii) we can
104
149
# get a unicode cannot encode ascii error, so make sure that "fmt"
105
150
# is a unicode string
106
out = unicode(fmt) % args
153
if isinstance(arg, unicode):
154
arg = arg.encode('utf8')
155
real_args.append(arg)
156
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
160
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
161
out = timestamp + out + '\n'
162
_trace_file.write(out)
163
# there's no explicit flushing; the file is typically line buffered.
166
def mutter_callsite(stacklevel, fmt, *args):
167
"""Perform a mutter of fmt and args, logging the call trace.
169
:param stacklevel: The number of frames to show. None will show all
171
:param fmt: The format string to pass to mutter.
172
:param args: A list of substitution variables.
175
if stacklevel is None:
178
limit = stacklevel + 1
179
traceback.print_stack(limit=limit, file=outf)
180
formatted_lines = outf.getvalue().splitlines()
181
formatted_stack = '\n'.join(formatted_lines[:-2])
182
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
120
185
def _rollover_trace_maybe(trace_fname):
124
189
if size <= 4 << 20:
126
191
old_fname = trace_fname + '.old'
127
from osutils import rename
128
rename(trace_fname, old_fname)
192
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)
197
def _get_bzr_log_filename():
198
bzr_log = os.environ.get('BZR_LOG')
201
home = os.environ.get('BZR_HOME')
203
if sys.platform == 'win32':
204
from bzrlib import win32utils
205
home = win32utils.get_home_location()
207
home = os.path.expanduser('~')
208
return os.path.join(home, '.bzr.log')
212
"""Open the .bzr.log trace file.
214
If the log is more than a particular length, the old file is renamed to
215
.bzr.log.old and a new file is started. Otherwise, we append to the
218
This sets the global _bzr_log_filename.
220
global _bzr_log_filename
222
def _open_or_create_log_file(filename):
223
"""Open existing log file, or create with ownership and permissions
225
It inherits the ownership and permissions (masked by umask) from
226
the containing directory to cope better with being run under sudo
227
with $HOME still set to the user's homedir.
229
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
232
fd = os.open(filename, flags)
235
if e.errno != errno.ENOENT:
238
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
240
if e.errno != errno.EEXIST:
243
osutils.copy_ownership_from_path(filename)
245
return os.fdopen(fd, 'at', 0) # unbuffered
248
_bzr_log_filename = _get_bzr_log_filename()
249
_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)
157
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()
251
bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
252
bzr_log_file.write('\n')
253
if bzr_log_file.tell() <= 2:
254
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
255
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
256
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
260
except EnvironmentError, e:
261
# If we are failing to open the log, then most likely logging has not
262
# been set up yet. So we just write to stderr rather than using
263
# 'warning()'. If we using warning(), users get the unhelpful 'no
264
# handlers registered for "bzr"' when something goes wrong on the
265
# server. (bug #503886)
266
sys.stderr.write("failed to open trace file: %s\n" % (e,))
267
# TODO: What should happen if we fail to open the trace file? Maybe the
268
# objects should be pointed at /dev/null or the equivalent? Currently
269
# returns None which will cause failures later.
273
def enable_default_logging():
274
"""Configure default logging: messages to stderr and debug to .bzr.log
276
This should only be called once per process.
278
Non-command-line programs embedding bzrlib do not need to call this. They
279
can instead either pass a file to _push_log_file, or act directly on
280
logging.getLogger("bzr").
282
Output can be redirected away by calling _push_log_file.
284
:return: A memento from push_log_file for restoring the log state.
286
start_time = osutils.format_local_date(_bzr_log_start_time,
288
# create encoded wrapper around stderr
289
bzr_log_file = _open_bzr_log()
290
if bzr_log_file is not None:
291
bzr_log_file.write(start_time.encode('utf-8') + '\n')
292
memento = push_log_file(bzr_log_file,
293
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
294
r'%Y-%m-%d %H:%M:%S')
295
# after hooking output into bzr_log, we also need to attach a stderr
296
# handler, writing only at level info and with encoding
297
term_encoding = osutils.get_terminal_encoding()
298
writer_factory = codecs.getwriter(term_encoding)
299
encoded_stderr = writer_factory(sys.stderr, errors='replace')
300
stderr_handler = logging.StreamHandler(encoded_stderr)
301
stderr_handler.setLevel(logging.INFO)
302
logging.getLogger('bzr').addHandler(stderr_handler)
306
def push_log_file(to_file, log_format=None, date_format=None):
307
"""Intercept log and trace messages and send them to a file.
309
:param to_file: A file-like object to which messages will be sent.
311
:returns: A memento that should be passed to _pop_log_file to restore the
312
previously active logging.
316
new_handler = logging.StreamHandler(to_file)
317
new_handler.setLevel(logging.DEBUG)
318
if log_format is None:
319
log_format = '%(levelname)8s %(message)s'
320
new_handler.setFormatter(logging.Formatter(log_format, date_format))
321
# save and remove any existing log handlers
322
bzr_logger = logging.getLogger('bzr')
323
old_handlers = bzr_logger.handlers[:]
324
del bzr_logger.handlers[:]
325
# set that as the default logger
326
bzr_logger.addHandler(new_handler)
327
bzr_logger.setLevel(logging.DEBUG)
328
# TODO: check if any changes are needed to the root logger
330
# TODO: also probably need to save and restore the level on bzr_logger.
331
# but maybe we can avoid setting the logger level altogether, and just set
332
# the level on the handler?
334
# save the old trace file
335
old_trace_file = _trace_file
336
# send traces to the new one
337
_trace_file = to_file
338
result = new_handler, _trace_file
339
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
342
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
343
"""Undo changes to logging/tracing done by _push_log_file.
345
This flushes, but does not close the trace file (so that anything that was
348
Takes the memento returned from _push_log_file."""
350
_trace_file = old_trace_file
351
bzr_logger = logging.getLogger('bzr')
352
bzr_logger.removeHandler(new_handler)
353
# must be closed, otherwise logging will try to close it at exit, and the
354
# file will likely already be closed underneath.
356
bzr_logger.handlers = old_handlers
357
if new_trace_file is not None:
358
new_trace_file.flush()
183
361
def log_exception_quietly():
184
362
"""Log the last exception to the trace file only.
186
Used for exceptions that occur internally and that may be
187
interesting to developers but not to users. For example,
364
Used for exceptions that occur internally and that may be
365
interesting to developers but not to users. For example,
188
366
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)
368
mutter(traceback.format_exc())
371
def set_verbosity_level(level):
372
"""Set the verbosity level.
374
:param level: -ve for quiet, 0 for normal, +ve for verbose
376
global _verbosity_level
377
_verbosity_level = level
378
_update_logging_level(level < 0)
379
ui.ui_factory.be_quiet(level < 0)
382
def get_verbosity_level():
383
"""Get the verbosity level.
385
See set_verbosity_level() for values.
387
return _verbosity_level
211
390
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)
392
set_verbosity_level(-1)
394
set_verbosity_level(0)
397
def _update_logging_level(quiet=True):
398
"""Hide INFO messages if quiet."""
400
_bzr_logger.setLevel(logging.WARNING)
402
_bzr_logger.setLevel(logging.INFO)
226
def disable_default_logging():
227
"""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)
406
"""Is the verbosity level negative?"""
407
return _verbosity_level < 0
411
"""Is the verbosity level positive?"""
412
return _verbosity_level > 0
415
def debug_memory(message='', short=True):
416
"""Write out a memory dump."""
417
if sys.platform == 'win32':
418
from bzrlib import win32utils
419
win32utils.debug_memory_win32api(message=message, short=short)
421
_debug_memory_proc(message=message, short=short)
424
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
426
def _debug_memory_proc(message='', short=True):
428
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
432
status = status_file.read()
437
for line in status.splitlines():
441
for field in _short_fields:
442
if line.startswith(field):
446
def _dump_memory_usage(err_file):
449
fd, name = tempfile.mkstemp(prefix="bzr_memdump", suffix=".json")
450
dump_file = os.fdopen(fd, 'w')
451
from meliae import scanner
452
scanner.dump_gc_objects(dump_file)
453
err_file.write("Memory dumped to %s\n" % name)
455
err_file.write("Dumping memory requires meliae module.\n")
456
log_exception_quietly()
458
err_file.write("Exception while dumping memory.\n")
459
log_exception_quietly()
461
if dump_file is not None:
467
def _qualified_exception_name(eclass, unqualified_bzrlib_errors=False):
468
"""Give name of error class including module for non-builtin exceptions
470
If `unqualified_bzrlib_errors` is True, errors specific to bzrlib will
471
also omit the module prefix.
473
class_name = eclass.__name__
474
module_name = eclass.__module__
475
if module_name in ("exceptions", "__main__") or (
476
unqualified_bzrlib_errors and module_name == "bzrlib.errors"):
478
return "%s.%s" % (module_name, class_name)
481
def report_exception(exc_info, err_file):
482
"""Report an exception to err_file (typically stderr) and to .bzr.log.
484
This will show either a full traceback or a short message as appropriate.
486
:return: The appropriate exit code for this error.
488
# Log the full traceback to ~/.bzr.log
489
log_exception_quietly()
490
if 'error' in debug.debug_flags:
491
print_exception(exc_info, err_file)
492
return errors.EXIT_ERROR
493
exc_type, exc_object, exc_tb = exc_info
494
if (isinstance(exc_object, IOError)
495
and getattr(exc_object, 'errno', None) == errno.EPIPE):
496
err_file.write("bzr: broken pipe\n")
497
return errors.EXIT_ERROR
498
elif isinstance(exc_object, KeyboardInterrupt):
499
err_file.write("bzr: interrupted\n")
500
return errors.EXIT_ERROR
501
elif isinstance(exc_object, MemoryError):
502
err_file.write("bzr: out of memory\n")
503
if 'mem_dump' in debug.debug_flags:
504
_dump_memory_usage(err_file)
506
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
507
return errors.EXIT_ERROR
508
elif isinstance(exc_object, ImportError) \
509
and str(exc_object).startswith("No module named "):
510
report_user_error(exc_info, err_file,
511
'You may need to install this Python library separately.')
512
return errors.EXIT_ERROR
513
elif not getattr(exc_object, 'internal_error', True):
514
report_user_error(exc_info, err_file)
515
return errors.EXIT_ERROR
516
elif isinstance(exc_object, (OSError, IOError)) or (
517
# GZ 2010-05-20: Like (exc_type is pywintypes.error) but avoid import
518
exc_type.__name__ == "error" and exc_type.__module__ == "pywintypes"):
519
# Might be nice to catch all of these and show them as something more
520
# specific, but there are too many cases at the moment.
521
report_user_error(exc_info, err_file)
522
return errors.EXIT_ERROR
524
report_bug(exc_info, err_file)
525
return errors.EXIT_INTERNAL_ERROR
528
def print_exception(exc_info, err_file):
529
exc_type, exc_object, exc_tb = exc_info
530
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
531
exc_type.__module__, exc_type.__name__, exc_object))
533
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
536
# TODO: Should these be specially encoding the output?
537
def report_user_error(exc_info, err_file, advice=None):
538
"""Report to err_file an error that's not an internal error.
540
These don't get a traceback unless -Derror was given.
542
:param exc_info: 3-tuple from sys.exc_info()
543
:param advice: Extra advice to the user to be printed following the
546
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
548
err_file.write("%s\n" % (advice,))
551
def report_bug(exc_info, err_file):
552
"""Report an exception that probably indicates a bug in bzr"""
553
from bzrlib.crash import report_bug
554
report_bug(exc_info, err_file)
557
def _flush_stdout_stderr():
558
# called from the bzrlib library finalizer returned by bzrlib.initialize()
564
if e.errno in [errno.EINVAL, errno.EPIPE]:
571
# called from the bzrlib library finalizer returned by bzrlib.initialize()
577
class Config(object):
578
"""Configuration of message tracing in bzrlib.
580
This implements the context manager protocol and should manage any global
581
variables still used. The default config used is DefaultConfig, but
582
embedded uses of bzrlib may wish to use a custom manager.
586
return self # This is bound to the 'as' clause in a with statement.
588
def __exit__(self, exc_type, exc_val, exc_tb):
589
return False # propogate exceptions.
592
class DefaultConfig(Config):
593
"""A default configuration for tracing of messages in bzrlib.
595
This implements the context manager protocol.
599
self._original_filename = _bzr_log_filename
600
self._original_state = enable_default_logging()
601
return self # This is bound to the 'as' clause in a with statement.
603
def __exit__(self, exc_type, exc_val, exc_tb):
604
pop_log_file(self._original_state)
605
global _bzr_log_filename
606
_bzr_log_filename = self._original_filename
607
return False # propogate exceptions.
added
removed
bzrlib/trace.py
