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.
127
bzrlib.ui.ui_factory.clear_term()
128
_bzr_logger.info(*args, **kwargs)
131
def warning(*args, **kwargs):
133
bzrlib.ui.ui_factory.clear_term()
134
_bzr_logger.warning(*args, **kwargs)
137
@deprecated_function(deprecated_in((2, 1, 0)))
138
def info(*args, **kwargs):
139
"""Deprecated: use trace.note instead."""
140
note(*args, **kwargs)
143
@deprecated_function(deprecated_in((2, 1, 0)))
144
def log_error(*args, **kwargs):
145
"""Deprecated: use bzrlib.trace.show_error instead"""
146
_bzr_logger.error(*args, **kwargs)
149
@deprecated_function(deprecated_in((2, 1, 0)))
150
def error(*args, **kwargs):
151
"""Deprecated: use bzrlib.trace.show_error instead"""
152
_bzr_logger.error(*args, **kwargs)
155
def show_error(*args, **kwargs):
156
"""Show an error message to the user.
158
Don't use this for exceptions, use report_exception instead.
160
_bzr_logger.error(*args, **kwargs)
163
def mutter(fmt, *args):
164
if _trace_file is None:
166
# XXX: Don't check this every time; instead anyone who closes the file
167
# ought to deregister it. We can tolerate None.
168
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
171
if isinstance(fmt, unicode):
172
fmt = fmt.encode('utf8')
175
# It seems that if we do ascii % (unicode, ascii) we can
176
# get a unicode cannot encode ascii error, so make sure that "fmt"
177
# is a unicode string
180
if isinstance(arg, unicode):
181
arg = arg.encode('utf8')
182
real_args.append(arg)
183
out = fmt % tuple(real_args)
187
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
188
out = timestamp + out + '\n'
189
_trace_file.write(out)
190
# there's no explicit flushing; the file is typically line buffered.
193
def mutter_callsite(stacklevel, fmt, *args):
194
"""Perform a mutter of fmt and args, logging the call trace.
196
:param stacklevel: The number of frames to show. None will show all
198
:param fmt: The format string to pass to mutter.
199
:param args: A list of substitution variables.
202
if stacklevel is None:
205
limit = stacklevel + 1
206
traceback.print_stack(limit=limit, file=outf)
207
formatted_lines = outf.getvalue().splitlines()
208
formatted_stack = '\n'.join(formatted_lines[:-2])
209
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
212
def _rollover_trace_maybe(trace_fname):
215
size = os.stat(trace_fname)[stat.ST_SIZE]
218
old_fname = trace_fname + '.old'
219
osutils.rename(trace_fname, old_fname)
224
def _get_bzr_log_filename():
225
bzr_log = os.environ.get('BZR_LOG')
228
home = os.environ.get('BZR_HOME')
230
if sys.platform == 'win32':
231
from bzrlib import win32utils
232
home = win32utils.get_home_location()
234
home = os.path.expanduser('~')
235
return os.path.join(home, '.bzr.log')
239
"""Open the .bzr.log trace file.
241
If the log is more than a particular length, the old file is renamed to
242
.bzr.log.old and a new file is started. Otherwise, we append to the
245
This sets the global _bzr_log_filename.
247
global _bzr_log_filename
249
def _open_or_create_log_file(filename):
250
"""Open existing log file, or create with ownership and permissions
252
It inherits the ownership and permissions (masked by umask) from
253
the containing directory to cope better with being run under sudo
254
with $HOME still set to the user's homedir.
256
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
259
fd = os.open(filename, flags)
262
if e.errno != errno.ENOENT:
265
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
267
if e.errno != errno.EEXIST:
270
osutils.copy_ownership_from_path(filename)
272
return os.fdopen(fd, 'at', 0) # unbuffered
275
_bzr_log_filename = _get_bzr_log_filename()
276
_rollover_trace_maybe(_bzr_log_filename)
278
bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
279
bzr_log_file.write('\n')
280
if bzr_log_file.tell() <= 2:
281
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
282
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
283
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
287
except EnvironmentError, e:
288
# If we are failing to open the log, then most likely logging has not
289
# been set up yet. So we just write to stderr rather than using
290
# 'warning()'. If we using warning(), users get the unhelpful 'no
291
# handlers registered for "bzr"' when something goes wrong on the
292
# server. (bug #503886)
293
sys.stderr.write("failed to open trace file: %s\n" % (e,))
294
# TODO: What should happen if we fail to open the trace file? Maybe the
295
# objects should be pointed at /dev/null or the equivalent? Currently
296
# returns None which will cause failures later.
300
def enable_default_logging():
301
"""Configure default logging: messages to stderr and debug to .bzr.log
303
This should only be called once per process.
305
Non-command-line programs embedding bzrlib do not need to call this. They
306
can instead either pass a file to _push_log_file, or act directly on
307
logging.getLogger("bzr").
309
Output can be redirected away by calling _push_log_file.
311
:return: A memento from push_log_file for restoring the log state.
313
start_time = osutils.format_local_date(_bzr_log_start_time,
315
# create encoded wrapper around stderr
316
bzr_log_file = _open_bzr_log()
317
if bzr_log_file is not None:
318
bzr_log_file.write(start_time.encode('utf-8') + '\n')
319
memento = push_log_file(bzr_log_file,
320
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
321
r'%Y-%m-%d %H:%M:%S')
322
# after hooking output into bzr_log, we also need to attach a stderr
323
# handler, writing only at level info and with encoding
324
term_encoding = osutils.get_terminal_encoding()
325
writer_factory = codecs.getwriter(term_encoding)
326
encoded_stderr = writer_factory(sys.stderr, errors='replace')
327
stderr_handler = logging.StreamHandler(encoded_stderr)
328
stderr_handler.setLevel(logging.INFO)
329
logging.getLogger('bzr').addHandler(stderr_handler)
333
def push_log_file(to_file, log_format=None, date_format=None):
334
"""Intercept log and trace messages and send them to a file.
336
:param to_file: A file-like object to which messages will be sent.
338
:returns: A memento that should be passed to _pop_log_file to restore the
339
previously active logging.
343
new_handler = logging.StreamHandler(to_file)
344
new_handler.setLevel(logging.DEBUG)
345
if log_format is None:
346
log_format = '%(levelname)8s %(message)s'
347
new_handler.setFormatter(logging.Formatter(log_format, date_format))
348
# save and remove any existing log handlers
349
bzr_logger = logging.getLogger('bzr')
350
old_handlers = bzr_logger.handlers[:]
351
del bzr_logger.handlers[:]
352
# set that as the default logger
353
bzr_logger.addHandler(new_handler)
354
bzr_logger.setLevel(logging.DEBUG)
355
# TODO: check if any changes are needed to the root logger
357
# TODO: also probably need to save and restore the level on bzr_logger.
358
# but maybe we can avoid setting the logger level altogether, and just set
359
# the level on the handler?
361
# save the old trace file
362
old_trace_file = _trace_file
363
# send traces to the new one
364
_trace_file = to_file
365
result = new_handler, _trace_file
366
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
369
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
370
"""Undo changes to logging/tracing done by _push_log_file.
372
This flushes, but does not close the trace file (so that anything that was
375
Takes the memento returned from _push_log_file."""
377
_trace_file = old_trace_file
378
bzr_logger = logging.getLogger('bzr')
379
bzr_logger.removeHandler(new_handler)
380
# must be closed, otherwise logging will try to close it at exit, and the
381
# file will likely already be closed underneath.
383
bzr_logger.handlers = old_handlers
384
if new_trace_file is not None:
385
new_trace_file.flush()
388
def log_exception_quietly():
389
"""Log the last exception to the trace file only.
391
Used for exceptions that occur internally and that may be
392
interesting to developers but not to users. For example,
393
errors loading plugins.
395
mutter(traceback.format_exc())
398
def set_verbosity_level(level):
399
"""Set the verbosity level.
401
:param level: -ve for quiet, 0 for normal, +ve for verbose
403
global _verbosity_level
404
_verbosity_level = level
405
_update_logging_level(level < 0)
406
ui.ui_factory.be_quiet(level < 0)
409
def get_verbosity_level():
410
"""Get the verbosity level.
412
See set_verbosity_level() for values.
414
return _verbosity_level
417
def be_quiet(quiet=True):
419
set_verbosity_level(-1)
421
set_verbosity_level(0)
424
def _update_logging_level(quiet=True):
425
"""Hide INFO messages if quiet."""
427
_bzr_logger.setLevel(logging.WARNING)
429
_bzr_logger.setLevel(logging.INFO)
433
"""Is the verbosity level negative?"""
434
return _verbosity_level < 0
438
"""Is the verbosity level positive?"""
439
return _verbosity_level > 0
442
def debug_memory(message='', short=True):
443
"""Write out a memory dump."""
444
if sys.platform == 'win32':
445
from bzrlib import win32utils
446
win32utils.debug_memory_win32api(message=message, short=short)
448
_debug_memory_proc(message=message, short=short)
451
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
453
def _debug_memory_proc(message='', short=True):
455
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
459
status = status_file.read()
464
for line in status.splitlines():
468
for field in _short_fields:
469
if line.startswith(field):
473
def _dump_memory_usage(err_file):
476
fd, name = tempfile.mkstemp(prefix="bzr_memdump", suffix=".json")
477
dump_file = os.fdopen(fd, 'w')
478
from meliae import scanner
479
scanner.dump_gc_objects(dump_file)
480
err_file.write("Memory dumped to %s\n" % name)
482
err_file.write("Dumping memory requires meliae module.\n")
483
log_exception_quietly()
485
err_file.write("Exception while dumping memory.\n")
486
log_exception_quietly()
488
if dump_file is not None:
493
def report_exception(exc_info, err_file):
494
"""Report an exception to err_file (typically stderr) and to .bzr.log.
496
This will show either a full traceback or a short message as appropriate.
498
:return: The appropriate exit code for this error.
500
# Log the full traceback to ~/.bzr.log
501
log_exception_quietly()
502
if 'error' in debug.debug_flags:
503
print_exception(exc_info, err_file)
504
return errors.EXIT_ERROR
505
exc_type, exc_object, exc_tb = exc_info
506
if (isinstance(exc_object, IOError)
507
and getattr(exc_object, 'errno', None) == errno.EPIPE):
508
err_file.write("bzr: broken pipe\n")
509
return errors.EXIT_ERROR
510
elif isinstance(exc_object, KeyboardInterrupt):
511
err_file.write("bzr: interrupted\n")
512
return errors.EXIT_ERROR
513
elif isinstance(exc_object, MemoryError):
514
err_file.write("bzr: out of memory\n")
515
if 'mem_dump' in debug.debug_flags:
516
_dump_memory_usage(err_file)
518
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
519
return errors.EXIT_ERROR
520
elif isinstance(exc_object, ImportError) \
521
and str(exc_object).startswith("No module named "):
522
report_user_error(exc_info, err_file,
523
'You may need to install this Python library separately.')
524
return errors.EXIT_ERROR
525
elif not getattr(exc_object, 'internal_error', True):
526
report_user_error(exc_info, err_file)
527
return errors.EXIT_ERROR
528
elif isinstance(exc_object, (OSError, IOError)) or (
529
# GZ 2010-05-20: Like (exc_type is pywintypes.error) but avoid import
530
exc_type.__name__ == "error" and exc_type.__module__ == "pywintypes"):
531
# Might be nice to catch all of these and show them as something more
532
# specific, but there are too many cases at the moment.
533
report_user_error(exc_info, err_file)
534
return errors.EXIT_ERROR
536
report_bug(exc_info, err_file)
537
return errors.EXIT_INTERNAL_ERROR
540
def print_exception(exc_info, err_file):
541
exc_type, exc_object, exc_tb = exc_info
542
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
543
exc_type.__module__, exc_type.__name__, exc_object))
545
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
548
# TODO: Should these be specially encoding the output?
549
def report_user_error(exc_info, err_file, advice=None):
550
"""Report to err_file an error that's not an internal error.
552
These don't get a traceback unless -Derror was given.
554
:param exc_info: 3-tuple from sys.exc_info()
555
:param advice: Extra advice to the user to be printed following the
558
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
560
err_file.write("%s\n" % (advice,))
563
def report_bug(exc_info, err_file):
564
"""Report an exception that probably indicates a bug in bzr"""
565
from bzrlib.crash import report_bug
566
report_bug(exc_info, err_file)
569
def _flush_stdout_stderr():
570
# called from the bzrlib library finalizer returned by bzrlib.initialize()
576
if e.errno in [errno.EINVAL, errno.EPIPE]:
583
# called from the bzrlib library finalizer returned by bzrlib.initialize()
589
class Config(object):
590
"""Configuration of message tracing in bzrlib.
592
This implements the context manager protocol and should manage any global
593
variables still used. The default config used is DefaultConfig, but
594
embedded uses of bzrlib may wish to use a custom manager.
598
return self # This is bound to the 'as' clause in a with statement.
600
def __exit__(self, exc_type, exc_val, exc_tb):
601
return False # propogate exceptions.
604
class DefaultConfig(Config):
605
"""A default configuration for tracing of messages in bzrlib.
607
This implements the context manager protocol.
611
self._original_filename = _bzr_log_filename
612
self._original_state = enable_default_logging()
613
return self # This is bound to the 'as' clause in a with statement.
615
def __exit__(self, exc_type, exc_val, exc_tb):
616
pop_log_file(self._original_state)
617
global _bzr_log_filename
618
_bzr_log_filename = self._original_filename
619
return False # propogate exceptions.
added
removed
bzrlib/trace.py
