1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Messages and logging for bazaar-ng.
19
Messages are supplied by callers as a string-formatting template, plus values
20
to be inserted into it. The actual %-formatting is deferred to the log
21
library so that it doesn't need to be done for messages that won't be emitted.
23
Messages are classified by severity levels: critical, error, warning, info,
26
They can be sent to two places: to stderr, and to ~/.bzr.log. For purposes
27
such as running the test suite, they can also be redirected away from both of
28
those two places to another location.
30
~/.bzr.log gets all messages, and full tracebacks for uncaught exceptions.
31
This trace file is always in UTF-8, regardless of the user's default encoding,
32
so that we can always rely on writing any message.
34
Output to stderr depends on the mode chosen by the user. By default, messages
35
of info and above are sent out, which results in progress messages such as the
36
list of files processed by add and commit. In quiet mode, only warnings and
37
above are shown. In debug mode, stderr gets debug messages too.
39
Errors that terminate an operation are generally passed back as exceptions;
40
others may be just emitted as messages.
42
Exceptions are reported in a brief form to stderr so as not to look scary.
43
BzrErrors are required to be able to format themselves into a properly
44
explanatory message. This is not true for builtin exceptions such as
45
KeyError, which typically just str to "0". They're printed in a different
49
# FIXME: Unfortunately it turns out that python's logging module
50
# is quite expensive, even when the message is not printed by any handlers.
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
64
from bzrlib.lazy_import import lazy_import
65
lazy_import(globals(), """
66
from cStringIO import StringIO
74
lazy_import(globals(), """
85
# global verbosity for bzrlib; controls the log level for stderr; 0=normal; <0
86
# is quiet; >0 is verbose.
89
# File-like object where mutter/debug output is currently sent. Can be
90
# changed by _push_log_file etc. This is directly manipulated by some
91
# external code; maybe there should be functions to do that more precisely
92
# than push/pop_log_file.
95
# Absolute path for ~/.bzr.log. Not changed even if the log/trace output is
96
# redirected elsewhere. Used to show the location in --version.
97
_bzr_log_filename = None
99
# The time the first message was written to the trace file, so that we can
100
# show relative times since startup.
101
_bzr_log_start_time = bzrlib._start_time
104
# held in a global for quick reference
105
_bzr_logger = logging.getLogger('bzr')
108
def note(*args, **kwargs):
109
# FIXME note always emits utf-8, regardless of the terminal encoding
111
# FIXME: clearing the ui and then going through the abstract logging
112
# framework is whack; we should probably have a logging Handler that
113
# deals with terminal output if needed.
115
bzrlib.ui.ui_factory.clear_term()
116
_bzr_logger.info(*args, **kwargs)
119
def warning(*args, **kwargs):
121
bzrlib.ui.ui_factory.clear_term()
122
_bzr_logger.warning(*args, **kwargs)
125
# configure convenient aliases for output routines
127
# TODO: deprecate them, have one name for each.
129
error = _bzr_logger.error
132
_last_mutter_flush_time = None
134
def mutter(fmt, *args):
135
global _last_mutter_flush_time
136
if _trace_file is None:
138
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
141
if isinstance(fmt, unicode):
142
fmt = fmt.encode('utf8')
145
# It seems that if we do ascii % (unicode, ascii) we can
146
# get a unicode cannot encode ascii error, so make sure that "fmt"
147
# is a unicode string
150
if isinstance(arg, unicode):
151
arg = arg.encode('utf8')
152
real_args.append(arg)
153
out = fmt % tuple(real_args)
157
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
158
out = timestamp + out + '\n'
159
_trace_file.write(out)
160
# We flush if we haven't flushed for a few seconds. We don't want to flush
161
# on every mutter, but when a command takes a while, it can be nice to see
162
# updates in the debug log.
163
if (_last_mutter_flush_time is None
164
or (now - _last_mutter_flush_time) > 2.0):
165
flush = getattr(_trace_file, 'flush', None)
166
if flush is not None:
168
_last_mutter_flush_time = now
171
def mutter_callsite(stacklevel, fmt, *args):
172
"""Perform a mutter of fmt and args, logging the call trace.
174
:param stacklevel: The number of frames to show. None will show all
176
:param fmt: The format string to pass to mutter.
177
:param args: A list of substitution variables.
180
if stacklevel is None:
183
limit = stacklevel + 1
184
traceback.print_stack(limit=limit, file=outf)
185
formatted_lines = outf.getvalue().splitlines()
186
formatted_stack = '\n'.join(formatted_lines[:-2])
187
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
190
def _rollover_trace_maybe(trace_fname):
193
size = os.stat(trace_fname)[stat.ST_SIZE]
196
old_fname = trace_fname + '.old'
197
osutils.rename(trace_fname, old_fname)
202
def _get_bzr_log_filename():
203
bzr_log = os.environ.get('BZR_LOG')
206
home = os.environ.get('BZR_HOME')
208
if sys.platform == 'win32':
209
from bzrlib import win32utils
210
home = win32utils.get_home_location()
212
home = os.path.expanduser('~')
213
return os.path.join(home, '.bzr.log')
217
"""Open the .bzr.log trace file.
219
If the log is more than a particular length, the old file is renamed to
220
.bzr.log.old and a new file is started. Otherwise, we append to the
223
This sets the global _bzr_log_filename.
225
global _bzr_log_filename
226
_bzr_log_filename = _get_bzr_log_filename()
227
_rollover_trace_maybe(_bzr_log_filename)
229
bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
230
# bzr_log_file.tell() on windows always return 0 until some writing done
231
bzr_log_file.write('\n')
232
if bzr_log_file.tell() <= 2:
233
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
234
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
235
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
238
warning("failed to open trace file: %s" % (e))
239
# TODO: What should happen if we fail to open the trace file? Maybe the
240
# objects should be pointed at /dev/null or the equivalent? Currently
241
# returns None which will cause failures later.
245
def enable_default_logging():
246
"""Configure default logging: messages to stderr and debug to .bzr.log
248
This should only be called once per process.
250
Non-command-line programs embedding bzrlib do not need to call this. They
251
can instead either pass a file to _push_log_file, or act directly on
252
logging.getLogger("bzr").
254
Output can be redirected away by calling _push_log_file.
256
# Do this before we open the log file, so we prevent
257
# get_terminal_encoding() from mutter()ing multiple times
258
term_encoding = osutils.get_terminal_encoding()
259
start_time = osutils.format_local_date(_bzr_log_start_time,
261
# create encoded wrapper around stderr
262
bzr_log_file = _open_bzr_log()
263
if bzr_log_file is not None:
264
bzr_log_file.write(start_time.encode('utf-8') + '\n')
265
push_log_file(bzr_log_file,
266
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
267
r'%Y-%m-%d %H:%M:%S')
268
# after hooking output into bzr_log, we also need to attach a stderr
269
# handler, writing only at level info and with encoding
270
writer_factory = codecs.getwriter(term_encoding)
271
encoded_stderr = writer_factory(sys.stderr, errors='replace')
272
stderr_handler = logging.StreamHandler(encoded_stderr)
273
stderr_handler.setLevel(logging.INFO)
274
logging.getLogger('bzr').addHandler(stderr_handler)
277
def push_log_file(to_file, log_format=None, date_format=None):
278
"""Intercept log and trace messages and send them to a file.
280
:param to_file: A file-like object to which messages will be sent.
282
:returns: A memento that should be passed to _pop_log_file to restore the
283
previously active logging.
287
new_handler = logging.StreamHandler(to_file)
288
new_handler.setLevel(logging.DEBUG)
289
if log_format is None:
290
log_format = '%(levelname)8s %(message)s'
291
new_handler.setFormatter(logging.Formatter(log_format, date_format))
292
# save and remove any existing log handlers
293
bzr_logger = logging.getLogger('bzr')
294
old_handlers = bzr_logger.handlers[:]
295
del bzr_logger.handlers[:]
296
# set that as the default logger
297
bzr_logger.addHandler(new_handler)
298
bzr_logger.setLevel(logging.DEBUG)
299
# TODO: check if any changes are needed to the root logger
301
# TODO: also probably need to save and restore the level on bzr_logger.
302
# but maybe we can avoid setting the logger level altogether, and just set
303
# the level on the handler?
305
# save the old trace file
306
old_trace_file = _trace_file
307
# send traces to the new one
308
_trace_file = to_file
309
result = new_handler, _trace_file
310
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
313
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
314
"""Undo changes to logging/tracing done by _push_log_file.
316
This flushes, but does not close the trace file.
318
Takes the memento returned from _push_log_file."""
320
_trace_file = old_trace_file
321
bzr_logger = logging.getLogger('bzr')
322
bzr_logger.removeHandler(new_handler)
323
# must be closed, otherwise logging will try to close it atexit, and the
324
# file will likely already be closed underneath.
326
bzr_logger.handlers = old_handlers
327
new_trace_file.flush()
330
def log_exception_quietly():
331
"""Log the last exception to the trace file only.
333
Used for exceptions that occur internally and that may be
334
interesting to developers but not to users. For example,
335
errors loading plugins.
337
mutter(traceback.format_exc())
340
def set_verbosity_level(level):
341
"""Set the verbosity level.
343
:param level: -ve for quiet, 0 for normal, +ve for verbose
345
global _verbosity_level
346
_verbosity_level = level
347
_update_logging_level(level < 0)
350
def get_verbosity_level():
351
"""Get the verbosity level.
353
See set_verbosity_level() for values.
355
return _verbosity_level
358
def be_quiet(quiet=True):
359
# Perhaps this could be deprecated now ...
361
set_verbosity_level(-1)
363
set_verbosity_level(0)
366
def _update_logging_level(quiet=True):
367
"""Hide INFO messages if quiet."""
369
_bzr_logger.setLevel(logging.WARNING)
371
_bzr_logger.setLevel(logging.INFO)
375
"""Is the verbosity level negative?"""
376
return _verbosity_level < 0
380
"""Is the verbosity level positive?"""
381
return _verbosity_level > 0
384
def debug_memory(message='', short=True):
385
"""Write out a memory dump."""
386
if sys.platform == 'win32':
387
from bzrlib import win32utils
388
win32utils.debug_memory_win32api(message=message, short=short)
390
_debug_memory_proc(message=message, short=short)
393
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
395
def _debug_memory_proc(message='', short=True):
397
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
401
status = status_file.read()
406
for line in status.splitlines():
410
for field in _short_fields:
411
if line.startswith(field):
416
def report_exception(exc_info, err_file):
417
"""Report an exception to err_file (typically stderr) and to .bzr.log.
419
This will show either a full traceback or a short message as appropriate.
421
:return: The appropriate exit code for this error.
423
exc_type, exc_object, exc_tb = exc_info
424
# Log the full traceback to ~/.bzr.log
425
log_exception_quietly()
426
if (isinstance(exc_object, IOError)
427
and getattr(exc_object, 'errno', None) == errno.EPIPE):
428
err_file.write("bzr: broken pipe\n")
429
return errors.EXIT_ERROR
430
elif isinstance(exc_object, KeyboardInterrupt):
431
err_file.write("bzr: interrupted\n")
432
return errors.EXIT_ERROR
433
elif isinstance(exc_object, MemoryError):
434
err_file.write("bzr: out of memory\n")
435
return errors.EXIT_ERROR
436
elif isinstance(exc_object, ImportError) \
437
and str(exc_object).startswith("No module named "):
438
report_user_error(exc_info, err_file,
439
'You may need to install this Python library separately.')
440
return errors.EXIT_ERROR
441
elif not getattr(exc_object, 'internal_error', True):
442
report_user_error(exc_info, err_file)
443
return errors.EXIT_ERROR
444
elif isinstance(exc_object, (OSError, IOError)):
445
# Might be nice to catch all of these and show them as something more
446
# specific, but there are too many cases at the moment.
447
report_user_error(exc_info, err_file)
448
return errors.EXIT_ERROR
450
report_bug(exc_info, err_file)
451
return errors.EXIT_INTERNAL_ERROR
454
def print_exception(exc_info, err_file):
455
exc_type, exc_object, exc_tb = exc_info
456
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
457
exc_type.__module__, exc_type.__name__, exc_object))
459
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
462
# TODO: Should these be specially encoding the output?
463
def report_user_error(exc_info, err_file, advice=None):
464
"""Report to err_file an error that's not an internal error.
466
These don't get a traceback unless -Derror was given.
468
:param exc_info: 3-tuple from sys.exc_info()
469
:param advice: Extra advice to the user to be printed following the
472
if 'error' in debug.debug_flags:
473
print_exception(exc_info, err_file)
475
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
477
err_file.write("%s\n" % (advice,))
480
def report_bug(exc_info, err_file):
481
"""Report an exception that probably indicates a bug in bzr"""
482
from bzrlib.crash import report_bug
483
report_bug(exc_info, err_file)
added
removed
bzrlib/trace.py
