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
_last_mutter_flush_time = None
127
def mutter(fmt, *args):
128
global _last_mutter_flush_time
129
if _trace_file is None:
131
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
134
if isinstance(fmt, unicode):
135
fmt = fmt.encode('utf8')
138
# It seems that if we do ascii % (unicode, ascii) we can
139
# get a unicode cannot encode ascii error, so make sure that "fmt"
140
# is a unicode string
143
if isinstance(arg, unicode):
144
arg = arg.encode('utf8')
145
real_args.append(arg)
146
out = fmt % tuple(real_args)
150
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
151
out = timestamp + out + '\n'
152
_trace_file.write(out)
153
# We flush if we haven't flushed for a few seconds. We don't want to flush
154
# on every mutter, but when a command takes a while, it can be nice to see
155
# updates in the debug log.
156
if (_last_mutter_flush_time is None
157
or (now - _last_mutter_flush_time) > 2.0):
158
flush = getattr(_trace_file, 'flush', None)
159
if flush is not None:
161
_last_mutter_flush_time = now
164
def mutter_callsite(stacklevel, fmt, *args):
165
"""Perform a mutter of fmt and args, logging the call trace.
167
:param stacklevel: The number of frames to show. None will show all
169
:param fmt: The format string to pass to mutter.
170
:param args: A list of substitution variables.
173
if stacklevel is None:
176
limit = stacklevel + 1
177
traceback.print_stack(limit=limit, file=outf)
178
formatted_lines = outf.getvalue().splitlines()
179
formatted_stack = '\n'.join(formatted_lines[:-2])
180
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
183
def _rollover_trace_maybe(trace_fname):
186
size = os.stat(trace_fname)[stat.ST_SIZE]
189
old_fname = trace_fname + '.old'
190
osutils.rename(trace_fname, old_fname)
195
def _get_bzr_log_filename():
196
bzr_log = os.environ.get('BZR_LOG')
199
home = os.environ.get('BZR_HOME')
201
if sys.platform == 'win32':
202
from bzrlib import win32utils
203
home = win32utils.get_home_location()
205
home = os.path.expanduser('~')
206
return os.path.join(home, '.bzr.log')
210
"""Open the .bzr.log trace file.
212
If the log is more than a particular length, the old file is renamed to
213
.bzr.log.old and a new file is started. Otherwise, we append to the
216
This sets the global _bzr_log_filename.
218
global _bzr_log_filename
219
_bzr_log_filename = _get_bzr_log_filename()
220
_rollover_trace_maybe(_bzr_log_filename)
222
bzr_log_file = open(_bzr_log_filename, 'at', 1) # line buffered
223
# bzr_log_file.tell() on windows always return 0 until some writing done
224
bzr_log_file.write('\n')
225
if bzr_log_file.tell() <= 2:
226
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
227
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
228
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
231
warning("failed to open trace file: %s" % (e))
232
# TODO: What should happen if we fail to open the trace file? Maybe the
233
# objects should be pointed at /dev/null or the equivalent? Currently
234
# returns None which will cause failures later.
238
def enable_default_logging():
239
"""Configure default logging: messages to stderr and debug to .bzr.log
241
This should only be called once per process.
243
Non-command-line programs embedding bzrlib do not need to call this. They
244
can instead either pass a file to _push_log_file, or act directly on
245
logging.getLogger("bzr").
247
Output can be redirected away by calling _push_log_file.
249
# Do this before we open the log file, so we prevent
250
# get_terminal_encoding() from mutter()ing multiple times
251
term_encoding = osutils.get_terminal_encoding()
252
start_time = osutils.format_local_date(_bzr_log_start_time,
254
# create encoded wrapper around stderr
255
bzr_log_file = _open_bzr_log()
256
if bzr_log_file is not None:
257
bzr_log_file.write(start_time.encode('utf-8') + '\n')
258
push_log_file(bzr_log_file,
259
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
260
r'%Y-%m-%d %H:%M:%S')
261
# after hooking output into bzr_log, we also need to attach a stderr
262
# handler, writing only at level info and with encoding
263
writer_factory = codecs.getwriter(term_encoding)
264
encoded_stderr = writer_factory(sys.stderr, errors='replace')
265
stderr_handler = logging.StreamHandler(encoded_stderr)
266
stderr_handler.setLevel(logging.INFO)
267
logging.getLogger('bzr').addHandler(stderr_handler)
270
def push_log_file(to_file, log_format=None, date_format=None):
271
"""Intercept log and trace messages and send them to a file.
273
:param to_file: A file-like object to which messages will be sent.
275
:returns: A memento that should be passed to _pop_log_file to restore the
276
previously active logging.
280
new_handler = logging.StreamHandler(to_file)
281
new_handler.setLevel(logging.DEBUG)
282
if log_format is None:
283
log_format = '%(levelname)8s %(message)s'
284
new_handler.setFormatter(logging.Formatter(log_format, date_format))
285
# save and remove any existing log handlers
286
bzr_logger = logging.getLogger('bzr')
287
old_handlers = bzr_logger.handlers[:]
288
del bzr_logger.handlers[:]
289
# set that as the default logger
290
bzr_logger.addHandler(new_handler)
291
bzr_logger.setLevel(logging.DEBUG)
292
# TODO: check if any changes are needed to the root logger
294
# TODO: also probably need to save and restore the level on bzr_logger.
295
# but maybe we can avoid setting the logger level altogether, and just set
296
# the level on the handler?
298
# save the old trace file
299
old_trace_file = _trace_file
300
# send traces to the new one
301
_trace_file = to_file
302
result = new_handler, _trace_file
303
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
306
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
307
"""Undo changes to logging/tracing done by _push_log_file.
309
This flushes, but does not close the trace file.
311
Takes the memento returned from _push_log_file."""
313
_trace_file = old_trace_file
314
bzr_logger = logging.getLogger('bzr')
315
bzr_logger.removeHandler(new_handler)
316
# must be closed, otherwise logging will try to close it atexit, and the
317
# file will likely already be closed underneath.
319
bzr_logger.handlers = old_handlers
320
new_trace_file.flush()
323
def log_exception_quietly():
324
"""Log the last exception to the trace file only.
326
Used for exceptions that occur internally and that may be
327
interesting to developers but not to users. For example,
328
errors loading plugins.
330
mutter(traceback.format_exc())
333
def set_verbosity_level(level):
334
"""Set the verbosity level.
336
:param level: -ve for quiet, 0 for normal, +ve for verbose
338
global _verbosity_level
339
_verbosity_level = level
340
_update_logging_level(level < 0)
343
def get_verbosity_level():
344
"""Get the verbosity level.
346
See set_verbosity_level() for values.
348
return _verbosity_level
351
def be_quiet(quiet=True):
352
# Perhaps this could be deprecated now ...
354
set_verbosity_level(-1)
356
set_verbosity_level(0)
359
def _update_logging_level(quiet=True):
360
"""Hide INFO messages if quiet."""
362
_bzr_logger.setLevel(logging.WARNING)
364
_bzr_logger.setLevel(logging.INFO)
368
"""Is the verbosity level negative?"""
369
return _verbosity_level < 0
373
"""Is the verbosity level positive?"""
374
return _verbosity_level > 0
377
def debug_memory(message='', short=True):
378
"""Write out a memory dump."""
379
if sys.platform == 'win32':
380
from bzrlib import win32utils
381
win32utils.debug_memory_win32api(message=message, short=short)
383
_debug_memory_proc(message=message, short=short)
386
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
388
def _debug_memory_proc(message='', short=True):
390
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
394
status = status_file.read()
399
for line in status.splitlines():
403
for field in _short_fields:
404
if line.startswith(field):
409
def report_exception(exc_info, err_file):
410
"""Report an exception to err_file (typically stderr) and to .bzr.log.
412
This will show either a full traceback or a short message as appropriate.
414
:return: The appropriate exit code for this error.
416
exc_type, exc_object, exc_tb = exc_info
417
# Log the full traceback to ~/.bzr.log
418
log_exception_quietly()
419
if (isinstance(exc_object, IOError)
420
and getattr(exc_object, 'errno', None) == errno.EPIPE):
421
err_file.write("bzr: broken pipe\n")
422
return errors.EXIT_ERROR
423
elif isinstance(exc_object, KeyboardInterrupt):
424
err_file.write("bzr: interrupted\n")
425
return errors.EXIT_ERROR
426
elif isinstance(exc_object, MemoryError):
427
err_file.write("bzr: out of memory\n")
428
return errors.EXIT_ERROR
429
elif isinstance(exc_object, ImportError) \
430
and str(exc_object).startswith("No module named "):
431
report_user_error(exc_info, err_file,
432
'You may need to install this Python library separately.')
433
return errors.EXIT_ERROR
434
elif not getattr(exc_object, 'internal_error', True):
435
report_user_error(exc_info, err_file)
436
return errors.EXIT_ERROR
437
elif isinstance(exc_object, (OSError, IOError)):
438
# Might be nice to catch all of these and show them as something more
439
# specific, but there are too many cases at the moment.
440
report_user_error(exc_info, err_file)
441
return errors.EXIT_ERROR
443
report_bug(exc_info, err_file)
444
return errors.EXIT_INTERNAL_ERROR
447
def print_exception(exc_info, err_file):
448
exc_type, exc_object, exc_tb = exc_info
449
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
450
exc_type.__module__, exc_type.__name__, exc_object))
452
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
455
# TODO: Should these be specially encoding the output?
456
def report_user_error(exc_info, err_file, advice=None):
457
"""Report to err_file an error that's not an internal error.
459
These don't get a traceback unless -Derror was given.
461
:param exc_info: 3-tuple from sys.exc_info()
462
:param advice: Extra advice to the user to be printed following the
465
if 'error' in debug.debug_flags:
466
print_exception(exc_info, err_file)
468
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
470
err_file.write("%s\n" % (advice,))
473
def report_bug(exc_info, err_file):
474
"""Report an exception that probably indicates a bug in bzr"""
475
from bzrlib.crash import report_bug
476
report_bug(exc_info, err_file)
added
removed
bzrlib/trace.py
