1
# Copyright (C) 2005-2011 Canonical Ltd
1
3
# This program is free software; you can redistribute it and/or modify
2
4
# it under the terms of the GNU General Public License as published by
3
5
# the Free Software Foundation; either version 2 of the License, or
4
6
# (at your option) any later version.
6
8
# This program is distributed in the hope that it will be useful,
7
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
8
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9
11
# GNU General Public License for more details.
11
13
# You should have received a copy of the GNU General Public License
12
14
# along with this program; if not, write to the Free Software
13
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
"""Messages and logging for bazaar-ng
18
Messages are sent out through the Python logging library.
20
They can be sent to two places: to stderr, and to ~/.bzr.log.
22
~/.bzr.log gets all messages, and tracebacks of all uncaught
25
Normally stderr only gets messages of level INFO and higher, and gets
26
only a summary of exceptions, not the traceback.
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Messages and logging.
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 debug mode, stderr gets debug messages too.
38
Errors that terminate an operation are generally passed back as exceptions;
39
others may be just emitted as messages.
41
Exceptions are reported in a brief form to stderr so as not to look scary.
42
BzrErrors are required to be able to format themselves into a properly
43
explanatory message. This is not true for builtin exceptions such as
44
KeyError, which typically just str to "0". They're printed in a different
30
# TODO: in debug mode, stderr should get full tracebacks and also
31
# debug messages. (Is this really needed?)
33
# TODO: When running the test suites, we should add an additional
34
# logger that sends messages into the test log file.
48
from __future__ import absolute_import
50
# FIXME: Unfortunately it turns out that python's logging module
51
# is quite expensive, even when the message is not printed by any handlers.
52
# We should perhaps change back to just simply doing it here.
54
# On the other hand, as of 1.2 we generally only call the mutter() statement
55
# if (according to debug_flags) we actually intend to write it. So the
56
# 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
44
_stderr_handler = None
47
class QuietFormatter(logging.Formatter):
48
"""Formatter that supresses the details of errors.
50
This is used by default on stderr so as not to scare the user.
52
# At first I tried overriding formatException to suppress the
53
# exception details, but that has global effect: no loggers
54
# can get the exception details is we suppress them here.
56
def format(self, record):
58
if record.levelno >= logging.WARNING:
59
s += record.levelname + ': '
61
s += record.getMessage()
64
# give just a summary of the exception, not the whole thing
65
exinfo = traceback.extract_tb(record.exc_info[2])
66
# the format of this string matches one of the REs
68
s += (' at %s line %d, in %s()\n' % exinfo[-1][:3])
69
s += ' see ~/.bzr.log for debug information'
77
# configure convenient aliases for output routines
75
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
79
105
_bzr_logger = logging.getLogger('bzr')
80
_bzr_logger.setLevel(logging.DEBUG)
82
info = note = _bzr_logger.info
83
warning = _bzr_logger.warning
84
log_error = _bzr_logger.error
85
error = _bzr_logger.error
86
mutter = _bzr_logger.debug
87
debug = _bzr_logger.debug
92
# we do the rollover using this code, rather than the default from python
93
# logging, because we only want to rollover at program startup, not on each
94
# message. maybe that's not a good enough reason.
108
def note(*args, **kwargs):
109
"""Output a note to the user.
111
Takes the same parameters as logging.info.
115
# FIXME: clearing the ui and then going through the abstract logging
116
# framework is whack; we should probably have a logging Handler that
117
# deals with terminal output if needed.
118
ui.ui_factory.clear_term()
119
_bzr_logger.info(*args, **kwargs)
122
def warning(*args, **kwargs):
123
ui.ui_factory.clear_term()
124
_bzr_logger.warning(*args, **kwargs)
127
def show_error(*args, **kwargs):
128
"""Show an error message to the user.
130
Don't use this for exceptions, use report_exception instead.
132
_bzr_logger.error(*args, **kwargs)
135
def mutter(fmt, *args):
136
if _trace_file is None:
138
# XXX: Don't check this every time; instead anyone who closes the file
139
# ought to deregister it. We can tolerate None.
140
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
143
if isinstance(fmt, unicode):
144
fmt = fmt.encode('utf8')
147
# It seems that if we do ascii % (unicode, ascii) we can
148
# get a unicode cannot encode ascii error, so make sure that "fmt"
149
# is a unicode string
152
if isinstance(arg, unicode):
153
arg = arg.encode('utf8')
154
real_args.append(arg)
155
out = fmt % tuple(real_args)
159
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
160
out = timestamp + out + '\n'
161
_trace_file.write(out)
162
# there's no explicit flushing; the file is typically line buffered.
165
def mutter_callsite(stacklevel, fmt, *args):
166
"""Perform a mutter of fmt and args, logging the call trace.
168
:param stacklevel: The number of frames to show. None will show all
170
:param fmt: The format string to pass to mutter.
171
:param args: A list of substitution variables.
174
if stacklevel is None:
177
limit = stacklevel + 1
178
traceback.print_stack(limit=limit, file=outf)
179
formatted_lines = outf.getvalue().splitlines()
180
formatted_stack = '\n'.join(formatted_lines[:-2])
181
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
96
184
def _rollover_trace_maybe(trace_fname):
100
188
if size <= 4 << 20:
102
190
old_fname = trace_fname + '.old'
105
# must remove before rename on windows
111
# might fail if in use on windows
112
os.rename(trace_fname, old_fname)
191
osutils.rename(trace_fname, old_fname)
120
def open_tracefile(tracefilename='~/.bzr.log'):
121
# Messages are always written to here, so that we have some
122
# information if something goes wrong. In a future version this
123
# file will be removed on successful completion.
127
trace_fname = os.path.join(os.path.expanduser(tracefilename))
128
_rollover_trace_maybe(trace_fname)
130
# buffering=1 means line buffered
196
def _get_bzr_log_filename():
197
bzr_log = os.environ.get('BZR_LOG')
200
home = os.environ.get('BZR_HOME')
202
if sys.platform == 'win32':
203
from bzrlib import win32utils
204
home = win32utils.get_home_location()
206
home = os.path.expanduser('~')
207
return os.path.join(home, '.bzr.log')
211
"""Open the .bzr.log trace file.
213
If the log is more than a particular length, the old file is renamed to
214
.bzr.log.old and a new file is started. Otherwise, we append to the
217
This sets the global _bzr_log_filename.
219
global _bzr_log_filename
221
def _open_or_create_log_file(filename):
222
"""Open existing log file, or create with ownership and permissions
224
It inherits the ownership and permissions (masked by umask) from
225
the containing directory to cope better with being run under sudo
226
with $HOME still set to the user's homedir.
228
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
231
fd = os.open(filename, flags)
234
if e.errno != errno.ENOENT:
237
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
239
if e.errno != errno.EEXIST:
242
osutils.copy_ownership_from_path(filename)
244
return os.fdopen(fd, 'at', 0) # unbuffered
247
_bzr_log_filename = _get_bzr_log_filename()
248
_rollover_trace_maybe(_bzr_log_filename)
132
tf = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
134
if os.fstat(tf.fileno())[stat.ST_SIZE] == 0:
135
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
136
tf.write("you can delete or truncate this file, or include sections in\n")
137
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
139
_file_handler = logging.StreamHandler(tf)
140
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
141
datefmt = r'%a %H:%M:%S'
142
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
143
_file_handler.setLevel(logging.DEBUG)
144
logging.getLogger('').addHandler(_file_handler)
147
warning("failed to open trace file: %s" % (e))
150
def log_startup(argv):
153
debug('bzr %s invoked on python %s (%s)',
155
'.'.join(map(str, sys.version_info)),
158
debug(' arguments: %r', argv)
159
debug(' working dir: %s', os.getcwdu())
162
def log_exception(msg=None):
163
"""Log the last exception into the trace file.
165
The exception string representation is used as the error
166
summary, unless msg is given.
172
if msg and (msg[-1] == '\n'):
175
_bzr_logger.exception(msg)
250
bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
251
bzr_log_file.write('\n')
252
if bzr_log_file.tell() <= 2:
253
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
254
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
255
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
259
except EnvironmentError, e:
260
# If we are failing to open the log, then most likely logging has not
261
# been set up yet. So we just write to stderr rather than using
262
# 'warning()'. If we using warning(), users get the unhelpful 'no
263
# handlers registered for "bzr"' when something goes wrong on the
264
# server. (bug #503886)
265
sys.stderr.write("failed to open trace file: %s\n" % (e,))
266
# TODO: What should happen if we fail to open the trace file? Maybe the
267
# objects should be pointed at /dev/null or the equivalent? Currently
268
# returns None which will cause failures later.
179
272
def enable_default_logging():
180
"""Configure default logging to stderr and .bzr.log"""
181
global _stderr_handler, _file_handler
183
_stderr_handler = logging.StreamHandler()
185
if not _file_handler:
186
open_tracefile() # also adds it
190
debug_flag = bool(os.environ['BZR_DEBUG'])
273
"""Configure default logging: messages to stderr and debug to .bzr.log
275
This should only be called once per process.
277
Non-command-line programs embedding bzrlib do not need to call this. They
278
can instead either pass a file to _push_log_file, or act directly on
279
logging.getLogger("bzr").
281
Output can be redirected away by calling _push_log_file.
283
:return: A memento from push_log_file for restoring the log state.
285
start_time = osutils.format_local_date(_bzr_log_start_time,
287
bzr_log_file = _open_bzr_log()
288
if bzr_log_file is not None:
289
bzr_log_file.write(start_time.encode('utf-8') + '\n')
290
memento = push_log_file(bzr_log_file,
291
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
292
r'%Y-%m-%d %H:%M:%S')
293
# after hooking output into bzr_log, we also need to attach a stderr
294
# handler, writing only at level info and with encoding
295
stderr_handler = EncodedStreamHandler(sys.stderr,
296
osutils.get_terminal_encoding(), 'replace', level=logging.INFO)
297
logging.getLogger('bzr').addHandler(stderr_handler)
301
def push_log_file(to_file, log_format=None, date_format=None):
302
"""Intercept log and trace messages and send them to a file.
304
:param to_file: A file-like object to which messages will be sent.
306
:returns: A memento that should be passed to _pop_log_file to restore the
307
previously active logging.
311
new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
312
if log_format is None:
313
log_format = '%(levelname)8s %(message)s'
314
new_handler.setFormatter(logging.Formatter(log_format, date_format))
315
# save and remove any existing log handlers
316
bzr_logger = logging.getLogger('bzr')
317
old_handlers = bzr_logger.handlers[:]
318
del bzr_logger.handlers[:]
319
# set that as the default logger
320
bzr_logger.addHandler(new_handler)
321
bzr_logger.setLevel(logging.DEBUG)
322
# TODO: check if any changes are needed to the root logger
324
# TODO: also probably need to save and restore the level on bzr_logger.
325
# but maybe we can avoid setting the logger level altogether, and just set
326
# the level on the handler?
328
# save the old trace file
329
old_trace_file = _trace_file
330
# send traces to the new one
331
_trace_file = to_file
332
result = new_handler, _trace_file
333
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
336
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
337
"""Undo changes to logging/tracing done by _push_log_file.
339
This flushes, but does not close the trace file (so that anything that was
342
Takes the memento returned from _push_log_file."""
344
_trace_file = old_trace_file
345
bzr_logger = logging.getLogger('bzr')
346
bzr_logger.removeHandler(new_handler)
347
# must be closed, otherwise logging will try to close it at exit, and the
348
# file will likely already be closed underneath.
350
bzr_logger.handlers = old_handlers
351
if new_trace_file is not None:
352
new_trace_file.flush()
355
def log_exception_quietly():
356
"""Log the last exception to the trace file only.
358
Used for exceptions that occur internally and that may be
359
interesting to developers but not to users. For example,
360
errors loading plugins.
362
mutter(traceback.format_exc())
365
def set_verbosity_level(level):
366
"""Set the verbosity level.
368
:param level: -ve for quiet, 0 for normal, +ve for verbose
370
global _verbosity_level
371
_verbosity_level = level
372
_update_logging_level(level < 0)
373
ui.ui_factory.be_quiet(level < 0)
376
def get_verbosity_level():
377
"""Get the verbosity level.
379
See set_verbosity_level() for values.
381
return _verbosity_level
384
def be_quiet(quiet=True):
386
set_verbosity_level(-1)
388
set_verbosity_level(0)
391
def _update_logging_level(quiet=True):
392
"""Hide INFO messages if quiet."""
394
_bzr_logger.setLevel(logging.WARNING)
396
_bzr_logger.setLevel(logging.INFO)
400
"""Is the verbosity level negative?"""
401
return _verbosity_level < 0
405
"""Is the verbosity level positive?"""
406
return _verbosity_level > 0
409
def debug_memory(message='', short=True):
410
"""Write out a memory dump."""
411
if sys.platform == 'win32':
412
from bzrlib import win32utils
413
win32utils.debug_memory_win32api(message=message, short=short)
415
_debug_memory_proc(message=message, short=short)
418
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
420
def _debug_memory_proc(message='', short=True):
422
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
426
status = status_file.read()
431
for line in status.splitlines():
435
for field in _short_fields:
436
if line.startswith(field):
440
def _dump_memory_usage(err_file):
443
fd, name = tempfile.mkstemp(prefix="bzr_memdump", suffix=".json")
444
dump_file = os.fdopen(fd, 'w')
445
from meliae import scanner
446
scanner.dump_gc_objects(dump_file)
447
err_file.write("Memory dumped to %s\n" % name)
449
err_file.write("Dumping memory requires meliae module.\n")
450
log_exception_quietly()
452
err_file.write("Exception while dumping memory.\n")
453
log_exception_quietly()
455
if dump_file is not None:
461
def _qualified_exception_name(eclass, unqualified_bzrlib_errors=False):
462
"""Give name of error class including module for non-builtin exceptions
464
If `unqualified_bzrlib_errors` is True, errors specific to bzrlib will
465
also omit the module prefix.
467
class_name = eclass.__name__
468
module_name = eclass.__module__
469
if module_name in ("exceptions", "__main__") or (
470
unqualified_bzrlib_errors and module_name == "bzrlib.errors"):
472
return "%s.%s" % (module_name, class_name)
475
def report_exception(exc_info, err_file):
476
"""Report an exception to err_file (typically stderr) and to .bzr.log.
478
This will show either a full traceback or a short message as appropriate.
480
:return: The appropriate exit code for this error.
482
# Log the full traceback to ~/.bzr.log
483
log_exception_quietly()
484
if 'error' in debug.debug_flags:
485
print_exception(exc_info, err_file)
486
return errors.EXIT_ERROR
487
exc_type, exc_object, exc_tb = exc_info
488
if isinstance(exc_object, KeyboardInterrupt):
489
err_file.write("bzr: interrupted\n")
490
return errors.EXIT_ERROR
491
elif isinstance(exc_object, MemoryError):
492
err_file.write("bzr: out of memory\n")
493
if 'mem_dump' in debug.debug_flags:
494
_dump_memory_usage(err_file)
496
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
497
return errors.EXIT_ERROR
498
elif isinstance(exc_object, ImportError) \
499
and str(exc_object).startswith("No module named "):
500
report_user_error(exc_info, err_file,
501
'You may need to install this Python library separately.')
502
return errors.EXIT_ERROR
503
elif not getattr(exc_object, 'internal_error', True):
504
report_user_error(exc_info, err_file)
505
return errors.EXIT_ERROR
506
elif osutils.is_environment_error(exc_object):
507
if getattr(exc_object, 'errno', None) == errno.EPIPE:
508
err_file.write("bzr: broken pipe\n")
509
return errors.EXIT_ERROR
510
# Might be nice to catch all of these and show them as something more
511
# specific, but there are too many cases at the moment.
512
report_user_error(exc_info, err_file)
513
return errors.EXIT_ERROR
515
report_bug(exc_info, err_file)
516
return errors.EXIT_INTERNAL_ERROR
519
def print_exception(exc_info, err_file):
520
exc_type, exc_object, exc_tb = exc_info
521
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
522
exc_type.__module__, exc_type.__name__, exc_object))
524
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
527
# TODO: Should these be specially encoding the output?
528
def report_user_error(exc_info, err_file, advice=None):
529
"""Report to err_file an error that's not an internal error.
531
These don't get a traceback unless -Derror was given.
533
:param exc_info: 3-tuple from sys.exc_info()
534
:param advice: Extra advice to the user to be printed following the
537
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
539
err_file.write("%s\n" % (advice,))
542
def report_bug(exc_info, err_file):
543
"""Report an exception that probably indicates a bug in bzr"""
544
from bzrlib.crash import report_bug
545
report_bug(exc_info, err_file)
548
def _flush_stdout_stderr():
549
# called from the bzrlib library finalizer returned by bzrlib.initialize()
553
except ValueError, e:
554
# On Windows, I get ValueError calling stdout.flush() on a closed
195
level = logging.DEBUG
196
fmt = '%(levelname)8s: %(message)s'
197
_stderr_handler.setFormatter(logging.Formatter(fmt))
200
# show only summary of exceptions
201
_stderr_handler.setFormatter(QuietFormatter())
203
_stderr_handler.setLevel(level)
204
_file_handler.setLevel(level)
206
logging.getLogger('').addHandler(_stderr_handler)
210
def disable_default_logging():
211
"""Turn off default log handlers.
213
This is intended to be used by the test framework, which doesn't
214
want leakage from the code-under-test into the main logs.
217
l = logging.getLogger('')
218
l.removeHandler(_stderr_handler)
220
l.removeHandler(_file_handler)
559
if e.errno in [errno.EINVAL, errno.EPIPE]:
566
# called from the bzrlib library finalizer returned by bzrlib.initialize()
572
class EncodedStreamHandler(logging.Handler):
573
"""Robustly write logging events to a stream using the specified encoding
575
Messages are expected to be formatted to unicode, but UTF-8 byte strings
576
are also accepted. An error during formatting or a str message in another
577
encoding will be quitely noted as an error in the Bazaar log file.
579
The stream is not closed so sys.stdout or sys.stderr may be passed.
582
def __init__(self, stream, encoding=None, errors='strict', level=0):
583
logging.Handler.__init__(self, level)
586
encoding = getattr(stream, "encoding", "ascii")
587
self.encoding = encoding
591
flush = getattr(self.stream, "flush", None)
592
if flush is not None:
595
def emit(self, record):
597
line = self.format(record)
598
if not isinstance(line, unicode):
599
line = line.decode("utf-8")
600
self.stream.write(line.encode(self.encoding, self.errors) + "\n")
602
log_exception_quietly()
603
# Try saving the details that would have been logged in some form
604
msg = args = "<Unformattable>"
606
msg = repr(record.msg).encode("ascii")
607
args = repr(record.args).encode("ascii")
610
# Using mutter() bypasses the logging module and writes directly
611
# to the file so there's no danger of getting into a loop here.
612
mutter("Logging record unformattable: %s %% %s", msg, args)
615
class Config(object):
616
"""Configuration of message tracing in bzrlib.
618
This implements the context manager protocol and should manage any global
619
variables still used. The default config used is DefaultConfig, but
620
embedded uses of bzrlib may wish to use a custom manager.
624
return self # This is bound to the 'as' clause in a with statement.
626
def __exit__(self, exc_type, exc_val, exc_tb):
627
return False # propogate exceptions.
630
class DefaultConfig(Config):
631
"""A default configuration for tracing of messages in bzrlib.
633
This implements the context manager protocol.
637
self._original_filename = _bzr_log_filename
638
self._original_state = enable_default_logging()
639
return self # This is bound to the 'as' clause in a with statement.
641
def __exit__(self, exc_type, exc_val, exc_tb):
642
pop_log_file(self._original_state)
643
global _bzr_log_filename
644
_bzr_log_filename = self._original_filename
645
return False # propogate exceptions.
added
removed
bzrlib/trace.py
