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
73
from bzrlib.symbol_versioning import (
78
lazy_import(globals(), """
90
# global verbosity for bzrlib; controls the log level for stderr; 0=normal; <0
91
# is quiet; >0 is verbose.
94
# File-like object where mutter/debug output is currently sent. Can be
95
# changed by _push_log_file etc. This is directly manipulated by some
96
# external code; maybe there should be functions to do that more precisely
97
# than push/pop_log_file.
58
class QuietFormatter(logging.Formatter):
59
"""Formatter that supresses the details of errors.
61
This is used by default on stderr so as not to scare the user.
63
# At first I tried overriding formatException to suppress the
64
# exception details, but that has global effect: no loggers
65
# can get the exception details is we suppress them here.
67
def format(self, record):
68
if record.levelno >= logging.WARNING:
69
s = 'bzr: ' + record.levelname + ': '
72
s += record.getMessage()
74
s += '\n' + format_exception_short(record.exc_info)
77
# configure convenient aliases for output routines
100
# Absolute path for ~/.bzr.log. Not changed even if the log/trace output is
101
# redirected elsewhere. Used to show the location in --version.
102
_bzr_log_filename = None
104
# The time the first message was written to the trace file, so that we can
105
# show relative times since startup.
106
_bzr_log_start_time = bzrlib._start_time
109
# held in a global for quick reference
79
110
_bzr_logger = logging.getLogger('bzr')
81
info = note = _bzr_logger.info
82
warning = _bzr_logger.warning
83
log_error = _bzr_logger.error
84
error = _bzr_logger.error
113
def note(*args, **kwargs):
114
"""Output a note to the user.
116
Takes the same parameters as logging.info.
119
# FIXME note always emits utf-8, regardless of the terminal encoding
121
# FIXME: clearing the ui and then going through the abstract logging
122
# framework is whack; we should probably have a logging Handler that
123
# deals with terminal output if needed.
125
bzrlib.ui.ui_factory.clear_term()
126
_bzr_logger.info(*args, **kwargs)
129
def warning(*args, **kwargs):
131
bzrlib.ui.ui_factory.clear_term()
132
_bzr_logger.warning(*args, **kwargs)
135
@deprecated_function(deprecated_in((2, 1, 0)))
136
def info(*args, **kwargs):
137
"""Deprecated: use trace.note instead."""
138
note(*args, **kwargs)
141
@deprecated_function(deprecated_in((2, 1, 0)))
142
def log_error(*args, **kwargs):
143
"""Deprecated: use bzrlib.trace.show_error instead"""
144
_bzr_logger.error(*args, **kwargs)
147
@deprecated_function(deprecated_in((2, 1, 0)))
148
def error(*args, **kwargs):
149
"""Deprecated: use bzrlib.trace.show_error instead"""
150
_bzr_logger.error(*args, **kwargs)
153
def show_error(*args, **kwargs):
154
"""Show an error message to the user.
156
Don't use this for exceptions, use report_exception instead.
158
_bzr_logger.error(*args, **kwargs)
87
161
def mutter(fmt, *args):
88
162
if _trace_file is None:
90
if hasattr(_trace_file, 'closed') and _trace_file.closed:
164
# XXX: Don't check this every time; instead anyone who closes the file
165
# ought to deregister it. We can tolerate None.
166
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
169
if isinstance(fmt, unicode):
170
fmt = fmt.encode('utf8')
173
# It seems that if we do ascii % (unicode, ascii) we can
174
# get a unicode cannot encode ascii error, so make sure that "fmt"
175
# is a unicode string
178
if isinstance(arg, unicode):
179
arg = arg.encode('utf8')
180
real_args.append(arg)
181
out = fmt % tuple(real_args)
185
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
186
out = timestamp + out + '\n'
97
187
_trace_file.write(out)
188
# there's no explicit flushing; the file is typically line buffered.
191
def mutter_callsite(stacklevel, fmt, *args):
192
"""Perform a mutter of fmt and args, logging the call trace.
194
:param stacklevel: The number of frames to show. None will show all
196
:param fmt: The format string to pass to mutter.
197
:param args: A list of substitution variables.
200
if stacklevel is None:
203
limit = stacklevel + 1
204
traceback.print_stack(limit=limit, file=outf)
205
formatted_lines = outf.getvalue().splitlines()
206
formatted_stack = '\n'.join(formatted_lines[:-2])
207
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
101
210
def _rollover_trace_maybe(trace_fname):
105
214
if size <= 4 << 20:
107
216
old_fname = trace_fname + '.old'
108
from osutils import rename
109
rename(trace_fname, old_fname)
217
osutils.rename(trace_fname, old_fname)
114
def open_tracefile(tracefilename='~/.bzr.log'):
115
# Messages are always written to here, so that we have some
116
# information if something goes wrong. In a future version this
117
# file will be removed on successful completion.
118
global _file_handler, _bzr_log_file
121
trace_fname = os.path.join(os.path.expanduser(tracefilename))
122
_rollover_trace_maybe(trace_fname)
222
def _get_bzr_log_filename():
223
bzr_log = os.environ.get('BZR_LOG')
226
home = os.environ.get('BZR_HOME')
228
if sys.platform == 'win32':
229
from bzrlib import win32utils
230
home = win32utils.get_home_location()
232
home = os.path.expanduser('~')
233
return os.path.join(home, '.bzr.log')
237
"""Open the .bzr.log trace file.
239
If the log is more than a particular length, the old file is renamed to
240
.bzr.log.old and a new file is started. Otherwise, we append to the
243
This sets the global _bzr_log_filename.
245
global _bzr_log_filename
247
def _open_or_create_log_file(filename):
248
"""Open existing log file, or create with ownership and permissions
250
It inherits the ownership and permissions (masked by umask) from
251
the containing directory to cope better with being run under sudo
252
with $HOME still set to the user's homedir.
254
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
257
fd = os.open(filename, flags)
260
if e.errno != errno.ENOENT:
263
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
265
if e.errno != errno.EEXIST:
268
osutils.copy_ownership_from_path(filename)
270
return os.fdopen(fd, 'at', 0) # unbuffered
273
_bzr_log_filename = _get_bzr_log_filename()
274
_rollover_trace_maybe(_bzr_log_filename)
125
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
128
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
129
tf.write("you can delete or truncate this file, or include sections in\n")
130
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
131
_file_handler = logging.StreamHandler(tf)
132
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
133
datefmt = r'%a %H:%M:%S'
134
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
135
_file_handler.setLevel(logging.DEBUG)
136
logging.getLogger('').addHandler(_file_handler)
138
warning("failed to open trace file: %s" % (e))
141
def log_startup(argv):
142
debug('\n\nbzr %s invoked on python %s (%s)',
144
'.'.join(map(str, sys.version_info)),
146
debug(' arguments: %r', argv)
147
debug(' working dir: %r', os.getcwdu())
150
def log_exception(msg=None):
151
"""Log the last exception to stderr and the trace file.
153
The exception string representation is used as the error
154
summary, unless msg is given.
159
exc_str = format_exception_short(sys.exc_info())
161
log_exception_quietly()
276
bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
277
bzr_log_file.write('\n')
278
if bzr_log_file.tell() <= 2:
279
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
280
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
281
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
285
except EnvironmentError, e:
286
# If we are failing to open the log, then most likely logging has not
287
# been set up yet. So we just write to stderr rather than using
288
# 'warning()'. If we using warning(), users get the unhelpful 'no
289
# handlers registered for "bzr"' when something goes wrong on the
290
# server. (bug #503886)
291
sys.stderr.write("failed to open trace file: %s\n" % (e,))
292
# TODO: What should happen if we fail to open the trace file? Maybe the
293
# objects should be pointed at /dev/null or the equivalent? Currently
294
# returns None which will cause failures later.
298
def enable_default_logging():
299
"""Configure default logging: messages to stderr and debug to .bzr.log
301
This should only be called once per process.
303
Non-command-line programs embedding bzrlib do not need to call this. They
304
can instead either pass a file to _push_log_file, or act directly on
305
logging.getLogger("bzr").
307
Output can be redirected away by calling _push_log_file.
309
# Do this before we open the log file, so we prevent
310
# get_terminal_encoding() from mutter()ing multiple times
311
term_encoding = osutils.get_terminal_encoding()
312
start_time = osutils.format_local_date(_bzr_log_start_time,
314
# create encoded wrapper around stderr
315
bzr_log_file = _open_bzr_log()
316
if bzr_log_file is not None:
317
bzr_log_file.write(start_time.encode('utf-8') + '\n')
318
push_log_file(bzr_log_file,
319
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
320
r'%Y-%m-%d %H:%M:%S')
321
# after hooking output into bzr_log, we also need to attach a stderr
322
# handler, writing only at level info and with encoding
323
writer_factory = codecs.getwriter(term_encoding)
324
encoded_stderr = writer_factory(sys.stderr, errors='replace')
325
stderr_handler = logging.StreamHandler(encoded_stderr)
326
stderr_handler.setLevel(logging.INFO)
327
logging.getLogger('bzr').addHandler(stderr_handler)
330
def push_log_file(to_file, log_format=None, date_format=None):
331
"""Intercept log and trace messages and send them to a file.
333
:param to_file: A file-like object to which messages will be sent.
335
:returns: A memento that should be passed to _pop_log_file to restore the
336
previously active logging.
340
new_handler = logging.StreamHandler(to_file)
341
new_handler.setLevel(logging.DEBUG)
342
if log_format is None:
343
log_format = '%(levelname)8s %(message)s'
344
new_handler.setFormatter(logging.Formatter(log_format, date_format))
345
# save and remove any existing log handlers
346
bzr_logger = logging.getLogger('bzr')
347
old_handlers = bzr_logger.handlers[:]
348
del bzr_logger.handlers[:]
349
# set that as the default logger
350
bzr_logger.addHandler(new_handler)
351
bzr_logger.setLevel(logging.DEBUG)
352
# TODO: check if any changes are needed to the root logger
354
# TODO: also probably need to save and restore the level on bzr_logger.
355
# but maybe we can avoid setting the logger level altogether, and just set
356
# the level on the handler?
358
# save the old trace file
359
old_trace_file = _trace_file
360
# send traces to the new one
361
_trace_file = to_file
362
result = new_handler, _trace_file
363
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
366
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
367
"""Undo changes to logging/tracing done by _push_log_file.
369
This flushes, but does not close the trace file.
371
Takes the memento returned from _push_log_file."""
373
_trace_file = old_trace_file
374
bzr_logger = logging.getLogger('bzr')
375
bzr_logger.removeHandler(new_handler)
376
# must be closed, otherwise logging will try to close it atexit, and the
377
# file will likely already be closed underneath.
379
bzr_logger.handlers = old_handlers
380
new_trace_file.flush()
164
383
def log_exception_quietly():
165
384
"""Log the last exception to the trace file only.
167
Used for exceptions that occur internally and that may be
168
interesting to developers but not to users. For example,
386
Used for exceptions that occur internally and that may be
387
interesting to developers but not to users. For example,
169
388
errors loading plugins.
172
debug(traceback.format_exc())
175
def enable_default_logging():
176
"""Configure default logging to stderr and .bzr.log"""
177
# FIXME: if this is run twice, things get confused
178
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
179
_stderr_handler = logging.StreamHandler()
180
_stderr_handler.setFormatter(QuietFormatter())
181
logging.getLogger('').addHandler(_stderr_handler)
182
_stderr_handler.setLevel(logging.INFO)
183
if not _file_handler:
185
_trace_file = _bzr_log_file
187
_file_handler.setLevel(logging.DEBUG)
188
_bzr_logger.setLevel(logging.DEBUG)
390
mutter(traceback.format_exc())
393
def set_verbosity_level(level):
394
"""Set the verbosity level.
396
:param level: -ve for quiet, 0 for normal, +ve for verbose
398
global _verbosity_level
399
_verbosity_level = level
400
_update_logging_level(level < 0)
401
ui.ui_factory.be_quiet(level < 0)
404
def get_verbosity_level():
405
"""Get the verbosity level.
407
See set_verbosity_level() for values.
409
return _verbosity_level
192
412
def be_quiet(quiet=True):
193
global _stderr_handler, _stderr_quiet
195
_stderr_quiet = quiet
197
_stderr_handler.setLevel(logging.WARNING)
199
_stderr_handler.setLevel(logging.INFO)
414
set_verbosity_level(-1)
416
set_verbosity_level(0)
419
def _update_logging_level(quiet=True):
420
"""Hide INFO messages if quiet."""
422
_bzr_logger.setLevel(logging.WARNING)
424
_bzr_logger.setLevel(logging.INFO)
207
def disable_default_logging():
208
"""Turn off default log handlers.
210
This is intended to be used by the test framework, which doesn't
211
want leakage from the code-under-test into the main logs.
214
l = logging.getLogger('')
215
l.removeHandler(_stderr_handler)
217
l.removeHandler(_file_handler)
221
def enable_test_log(to_file):
222
"""Redirect logging to a temporary file for a test
224
returns an opaque reference that should be passed to disable_test_log
225
after the test complete.
227
disable_default_logging()
428
"""Is the verbosity level negative?"""
429
return _verbosity_level < 0
433
"""Is the verbosity level positive?"""
434
return _verbosity_level > 0
437
def debug_memory(message='', short=True):
438
"""Write out a memory dump."""
439
if sys.platform == 'win32':
440
from bzrlib import win32utils
441
win32utils.debug_memory_win32api(message=message, short=short)
443
_debug_memory_proc(message=message, short=short)
446
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
448
def _debug_memory_proc(message='', short=True):
450
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
454
status = status_file.read()
459
for line in status.splitlines():
463
for field in _short_fields:
464
if line.startswith(field):
469
def report_exception(exc_info, err_file):
470
"""Report an exception to err_file (typically stderr) and to .bzr.log.
472
This will show either a full traceback or a short message as appropriate.
474
:return: The appropriate exit code for this error.
476
# Log the full traceback to ~/.bzr.log
477
log_exception_quietly()
478
if 'error' in debug.debug_flags:
479
print_exception(exc_info, err_file)
480
return errors.EXIT_ERROR
481
exc_type, exc_object, exc_tb = exc_info
482
if (isinstance(exc_object, IOError)
483
and getattr(exc_object, 'errno', None) == errno.EPIPE):
484
err_file.write("bzr: broken pipe\n")
485
return errors.EXIT_ERROR
486
elif isinstance(exc_object, KeyboardInterrupt):
487
err_file.write("bzr: interrupted\n")
488
return errors.EXIT_ERROR
489
elif isinstance(exc_object, MemoryError):
490
err_file.write("bzr: out of memory\n")
491
return errors.EXIT_ERROR
492
elif isinstance(exc_object, ImportError) \
493
and str(exc_object).startswith("No module named "):
494
report_user_error(exc_info, err_file,
495
'You may need to install this Python library separately.')
496
return errors.EXIT_ERROR
497
elif not getattr(exc_object, 'internal_error', True):
498
report_user_error(exc_info, err_file)
499
return errors.EXIT_ERROR
500
elif isinstance(exc_object, (OSError, IOError)):
501
# Might be nice to catch all of these and show them as something more
502
# specific, but there are too many cases at the moment.
503
report_user_error(exc_info, err_file)
504
return errors.EXIT_ERROR
506
report_bug(exc_info, err_file)
507
return errors.EXIT_INTERNAL_ERROR
510
def print_exception(exc_info, err_file):
511
exc_type, exc_object, exc_tb = exc_info
512
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
513
exc_type.__module__, exc_type.__name__, exc_object))
515
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
518
# TODO: Should these be specially encoding the output?
519
def report_user_error(exc_info, err_file, advice=None):
520
"""Report to err_file an error that's not an internal error.
522
These don't get a traceback unless -Derror was given.
524
:param exc_info: 3-tuple from sys.exc_info()
525
:param advice: Extra advice to the user to be printed following the
528
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
530
err_file.write("%s\n" % (advice,))
533
def report_bug(exc_info, err_file):
534
"""Report an exception that probably indicates a bug in bzr"""
535
from bzrlib.crash import report_bug
536
report_bug(exc_info, err_file)
539
def _flush_stdout_stderr():
540
# installed into an atexit hook by bzrlib.initialize()
546
if e.errno in [errno.EINVAL, errno.EPIPE]:
553
# run from atexit hook
228
554
global _trace_file
229
hdlr = logging.StreamHandler(to_file)
230
hdlr.setLevel(logging.DEBUG)
231
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
232
_bzr_logger.addHandler(hdlr)
233
_bzr_logger.setLevel(logging.DEBUG)
234
result = hdlr, _trace_file
235
_trace_file = to_file
239
def disable_test_log((test_log_hdlr, old_trace_file)):
240
_bzr_logger.removeHandler(test_log_hdlr)
241
_trace_file = old_trace_file
242
enable_default_logging()
245
def format_exception_short(exc_info):
246
"""Make a short string form of an exception.
248
This is used for display to stderr. It specially handles exception
249
classes without useful string methods.
251
The result has no trailing newline.
253
exc_info - typically an exception from sys.exc_info()
255
exc_type, exc_object, exc_tb = exc_info
258
return '(no exception)'
259
if isinstance(exc_object, (BzrError, BzrNewError)):
260
return str(exc_object)
263
tb = traceback.extract_tb(exc_tb)
264
msg = '%s: %s' % (exc_type, exc_object)
268
msg += '\n at %s line %d\n in %s' % (tb[-1][:3])
270
except Exception, formatting_exc:
271
# XXX: is this really better than just letting it run up?
272
return '(error formatting exception of type %s: %s)' \
273
% (exc_type, formatting_exc)
added
removed
bzrlib/trace.py
