1
# Copyright (C) 2005-2010 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.
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
48
# FIXME: Unfortunately it turns out that python's logging module
49
# is quite expensive, even when the message is not printed by any handlers.
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
64
from bzrlib.lazy_import import lazy_import
65
lazy_import(globals(), """
66
from cStringIO import StringIO
74
from bzrlib.symbol_versioning import (
79
lazy_import(globals(), """
91
# global verbosity for bzrlib; controls the log level for stderr; 0=normal; <0
92
# is quiet; >0 is verbose.
95
# File-like object where mutter/debug output is currently sent. Can be
96
# changed by _push_log_file etc. This is directly manipulated by some
97
# external code; maybe there should be functions to do that more precisely
98
# than push/pop_log_file.
101
# Absolute path for ~/.bzr.log. Not changed even if the log/trace output is
102
# redirected elsewhere. Used to show the location in --version.
103
_bzr_log_filename = None
105
# The time the first message was written to the trace file, so that we can
106
# show relative times since startup.
107
_bzr_log_start_time = bzrlib._start_time
110
# held in a global for quick reference
111
_bzr_logger = logging.getLogger('bzr')
114
def note(*args, **kwargs):
115
"""Output a note to the user.
117
Takes the same parameters as logging.info.
121
# FIXME note always emits utf-8, regardless of the terminal encoding
123
# FIXME: clearing the ui and then going through the abstract logging
124
# framework is whack; we should probably have a logging Handler that
125
# deals with terminal output if needed.
126
ui.ui_factory.clear_term()
127
_bzr_logger.info(*args, **kwargs)
130
def warning(*args, **kwargs):
131
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)
161
def mutter(fmt, *args):
162
if _trace_file is None:
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'
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,)))
210
def _rollover_trace_maybe(trace_fname):
213
size = os.stat(trace_fname)[stat.ST_SIZE]
216
old_fname = trace_fname + '.old'
217
osutils.rename(trace_fname, old_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)
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
:return: A memento from push_log_file for restoring the log state.
311
start_time = osutils.format_local_date(_bzr_log_start_time,
313
# create encoded wrapper around stderr
314
bzr_log_file = _open_bzr_log()
315
if bzr_log_file is not None:
316
bzr_log_file.write(start_time.encode('utf-8') + '\n')
317
memento = push_log_file(bzr_log_file,
318
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
319
r'%Y-%m-%d %H:%M:%S')
320
# after hooking output into bzr_log, we also need to attach a stderr
321
# handler, writing only at level info and with encoding
322
term_encoding = osutils.get_terminal_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)
331
def push_log_file(to_file, log_format=None, date_format=None):
332
"""Intercept log and trace messages and send them to a file.
334
:param to_file: A file-like object to which messages will be sent.
336
:returns: A memento that should be passed to _pop_log_file to restore the
337
previously active logging.
341
new_handler = logging.StreamHandler(to_file)
342
new_handler.setLevel(logging.DEBUG)
343
if log_format is None:
344
log_format = '%(levelname)8s %(message)s'
345
new_handler.setFormatter(logging.Formatter(log_format, date_format))
346
# save and remove any existing log handlers
347
bzr_logger = logging.getLogger('bzr')
348
old_handlers = bzr_logger.handlers[:]
349
del bzr_logger.handlers[:]
350
# set that as the default logger
351
bzr_logger.addHandler(new_handler)
352
bzr_logger.setLevel(logging.DEBUG)
353
# TODO: check if any changes are needed to the root logger
355
# TODO: also probably need to save and restore the level on bzr_logger.
356
# but maybe we can avoid setting the logger level altogether, and just set
357
# the level on the handler?
359
# save the old trace file
360
old_trace_file = _trace_file
361
# send traces to the new one
362
_trace_file = to_file
363
result = new_handler, _trace_file
364
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
367
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
368
"""Undo changes to logging/tracing done by _push_log_file.
370
This flushes, but does not close the trace file (so that anything that was
373
Takes the memento returned from _push_log_file."""
375
_trace_file = old_trace_file
376
bzr_logger = logging.getLogger('bzr')
377
bzr_logger.removeHandler(new_handler)
378
# must be closed, otherwise logging will try to close it at exit, and the
379
# file will likely already be closed underneath.
381
bzr_logger.handlers = old_handlers
382
if new_trace_file is not None:
383
new_trace_file.flush()
386
def log_exception_quietly():
387
"""Log the last exception to the trace file only.
389
Used for exceptions that occur internally and that may be
390
interesting to developers but not to users. For example,
391
errors loading plugins.
393
mutter(traceback.format_exc())
396
def set_verbosity_level(level):
397
"""Set the verbosity level.
399
:param level: -ve for quiet, 0 for normal, +ve for verbose
401
global _verbosity_level
402
_verbosity_level = level
403
_update_logging_level(level < 0)
404
ui.ui_factory.be_quiet(level < 0)
407
def get_verbosity_level():
408
"""Get the verbosity level.
410
See set_verbosity_level() for values.
412
return _verbosity_level
415
def be_quiet(quiet=True):
417
set_verbosity_level(-1)
419
set_verbosity_level(0)
422
def _update_logging_level(quiet=True):
423
"""Hide INFO messages if quiet."""
425
_bzr_logger.setLevel(logging.WARNING)
427
_bzr_logger.setLevel(logging.INFO)
431
"""Is the verbosity level negative?"""
432
return _verbosity_level < 0
436
"""Is the verbosity level positive?"""
437
return _verbosity_level > 0
440
def debug_memory(message='', short=True):
441
"""Write out a memory dump."""
442
if sys.platform == 'win32':
443
from bzrlib import win32utils
444
win32utils.debug_memory_win32api(message=message, short=short)
446
_debug_memory_proc(message=message, short=short)
449
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
451
def _debug_memory_proc(message='', short=True):
453
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
457
status = status_file.read()
462
for line in status.splitlines():
466
for field in _short_fields:
467
if line.startswith(field):
471
def _dump_memory_usage(err_file):
474
fd, name = tempfile.mkstemp(prefix="bzr_memdump", suffix=".json")
475
dump_file = os.fdopen(fd, 'w')
476
from meliae import scanner
477
scanner.dump_gc_objects(dump_file)
478
err_file.write("Memory dumped to %s\n" % name)
480
err_file.write("Dumping memory requires meliae module.\n")
481
log_exception_quietly()
483
err_file.write("Exception while dumping memory.\n")
484
log_exception_quietly()
486
if dump_file is not None:
492
def _qualified_exception_name(eclass, unqualified_bzrlib_errors=False):
493
"""Give name of error class including module for non-builtin exceptions
495
If `unqualified_bzrlib_errors` is True, errors specific to bzrlib will
496
also omit the module prefix.
498
class_name = eclass.__name__
499
module_name = eclass.__module__
500
if module_name in ("exceptions", "__main__") or (
501
unqualified_bzrlib_errors and module_name == "bzrlib.errors"):
503
return "%s.%s" % (module_name, class_name)
506
def report_exception(exc_info, err_file):
507
"""Report an exception to err_file (typically stderr) and to .bzr.log.
509
This will show either a full traceback or a short message as appropriate.
511
:return: The appropriate exit code for this error.
513
# Log the full traceback to ~/.bzr.log
514
log_exception_quietly()
515
if 'error' in debug.debug_flags:
516
print_exception(exc_info, err_file)
517
return errors.EXIT_ERROR
518
exc_type, exc_object, exc_tb = exc_info
519
if (isinstance(exc_object, IOError)
520
and getattr(exc_object, 'errno', None) == errno.EPIPE):
521
err_file.write("bzr: broken pipe\n")
522
return errors.EXIT_ERROR
523
elif isinstance(exc_object, KeyboardInterrupt):
524
err_file.write("bzr: interrupted\n")
525
return errors.EXIT_ERROR
526
elif isinstance(exc_object, MemoryError):
527
err_file.write("bzr: out of memory\n")
528
if 'mem_dump' in debug.debug_flags:
529
_dump_memory_usage(err_file)
531
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
532
return errors.EXIT_ERROR
533
elif isinstance(exc_object, ImportError) \
534
and str(exc_object).startswith("No module named "):
535
report_user_error(exc_info, err_file,
536
'You may need to install this Python library separately.')
537
return errors.EXIT_ERROR
538
elif not getattr(exc_object, 'internal_error', True):
539
report_user_error(exc_info, err_file)
540
return errors.EXIT_ERROR
541
elif isinstance(exc_object, (OSError, IOError)) or (
542
# GZ 2010-05-20: Like (exc_type is pywintypes.error) but avoid import
543
exc_type.__name__ == "error" and exc_type.__module__ == "pywintypes"):
544
# Might be nice to catch all of these and show them as something more
545
# specific, but there are too many cases at the moment.
546
report_user_error(exc_info, err_file)
547
return errors.EXIT_ERROR
549
report_bug(exc_info, err_file)
550
return errors.EXIT_INTERNAL_ERROR
553
def print_exception(exc_info, err_file):
554
exc_type, exc_object, exc_tb = exc_info
555
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
556
exc_type.__module__, exc_type.__name__, exc_object))
558
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
561
# TODO: Should these be specially encoding the output?
562
def report_user_error(exc_info, err_file, advice=None):
563
"""Report to err_file an error that's not an internal error.
565
These don't get a traceback unless -Derror was given.
567
:param exc_info: 3-tuple from sys.exc_info()
568
:param advice: Extra advice to the user to be printed following the
571
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
573
err_file.write("%s\n" % (advice,))
576
def report_bug(exc_info, err_file):
577
"""Report an exception that probably indicates a bug in bzr"""
578
from bzrlib.crash import report_bug
579
report_bug(exc_info, err_file)
582
def _flush_stdout_stderr():
583
# called from the bzrlib library finalizer returned by bzrlib.initialize()
589
if e.errno in [errno.EINVAL, errno.EPIPE]:
596
# called from the bzrlib library finalizer returned by bzrlib.initialize()
602
class Config(object):
603
"""Configuration of message tracing in bzrlib.
605
This implements the context manager protocol and should manage any global
606
variables still used. The default config used is DefaultConfig, but
607
embedded uses of bzrlib may wish to use a custom manager.
611
return self # This is bound to the 'as' clause in a with statement.
613
def __exit__(self, exc_type, exc_val, exc_tb):
614
return False # propogate exceptions.
617
class DefaultConfig(Config):
618
"""A default configuration for tracing of messages in bzrlib.
620
This implements the context manager protocol.
624
self._original_filename = _bzr_log_filename
625
self._original_state = enable_default_logging()
626
return self # This is bound to the 'as' clause in a with statement.
628
def __exit__(self, exc_type, exc_val, exc_tb):
629
pop_log_file(self._original_state)
630
global _bzr_log_filename
631
_bzr_log_filename = self._original_filename
632
return False # propogate exceptions.
added
removed
bzrlib/trace.py
