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
63
from bzrlib.lazy_import import lazy_import
64
lazy_import(globals(), """
65
from cStringIO import StringIO
73
from bzrlib.symbol_versioning import (
78
lazy_import(globals(), """
90
# global verbosity for bzrlib; controls the log level for stderr; 0=normal; <0
91
# is quiet; >0 is verbose.
94
# File-like object where mutter/debug output is currently sent. Can be
95
# changed by _push_log_file etc. This is directly manipulated by some
96
# external code; maybe there should be functions to do that more precisely
97
# than push/pop_log_file.
100
# Absolute path for ~/.bzr.log. Not changed even if the log/trace output is
101
# redirected elsewhere. Used to show the location in --version.
102
_bzr_log_filename = None
104
# The time the first message was written to the trace file, so that we can
105
# show relative times since startup.
106
_bzr_log_start_time = bzrlib._start_time
109
# held in a global for quick reference
110
_bzr_logger = logging.getLogger('bzr')
113
def note(*args, **kwargs):
114
# FIXME note always emits utf-8, regardless of the terminal encoding
116
# FIXME: clearing the ui and then going through the abstract logging
117
# framework is whack; we should probably have a logging Handler that
118
# deals with terminal output if needed.
120
bzrlib.ui.ui_factory.clear_term()
121
_bzr_logger.info(*args, **kwargs)
124
def warning(*args, **kwargs):
126
bzrlib.ui.ui_factory.clear_term()
127
_bzr_logger.warning(*args, **kwargs)
130
@deprecated_function(deprecated_in((2, 1, 0)))
131
def info(*args, **kwargs):
132
"""Deprecated: use trace.note instead."""
133
note(*args, **kwargs)
136
@deprecated_function(deprecated_in((2, 1, 0)))
137
def log_error(*args, **kwargs):
138
"""Deprecated: use bzrlib.trace.show_error instead"""
139
_bzr_logger.error(*args, **kwargs)
142
@deprecated_function(deprecated_in((2, 1, 0)))
143
def error(*args, **kwargs):
144
"""Deprecated: use bzrlib.trace.show_error instead"""
145
_bzr_logger.error(*args, **kwargs)
148
def show_error(*args, **kwargs):
149
"""Show an error message to the user.
151
Don't use this for exceptions, use report_exception instead.
153
_bzr_logger.error(*args, **kwargs)
156
def mutter(fmt, *args):
157
if _trace_file is None:
159
# XXX: Don't check this every time; instead anyone who closes the file
160
# ought to deregister it. We can tolerate None.
161
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
164
if isinstance(fmt, unicode):
165
fmt = fmt.encode('utf8')
168
# It seems that if we do ascii % (unicode, ascii) we can
169
# get a unicode cannot encode ascii error, so make sure that "fmt"
170
# is a unicode string
173
if isinstance(arg, unicode):
174
arg = arg.encode('utf8')
175
real_args.append(arg)
176
out = fmt % tuple(real_args)
180
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
181
out = timestamp + out + '\n'
182
_trace_file.write(out)
183
# there's no explicit flushing; the file is typically line buffered.
186
def mutter_callsite(stacklevel, fmt, *args):
187
"""Perform a mutter of fmt and args, logging the call trace.
189
:param stacklevel: The number of frames to show. None will show all
191
:param fmt: The format string to pass to mutter.
192
:param args: A list of substitution variables.
195
if stacklevel is None:
198
limit = stacklevel + 1
199
traceback.print_stack(limit=limit, file=outf)
200
formatted_lines = outf.getvalue().splitlines()
201
formatted_stack = '\n'.join(formatted_lines[:-2])
202
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
205
def _rollover_trace_maybe(trace_fname):
208
size = os.stat(trace_fname)[stat.ST_SIZE]
211
old_fname = trace_fname + '.old'
212
osutils.rename(trace_fname, old_fname)
217
def _get_bzr_log_filename():
218
bzr_log = os.environ.get('BZR_LOG')
221
home = os.environ.get('BZR_HOME')
223
if sys.platform == 'win32':
224
from bzrlib import win32utils
225
home = win32utils.get_home_location()
227
home = os.path.expanduser('~')
228
return os.path.join(home, '.bzr.log')
232
"""Open the .bzr.log trace file.
234
If the log is more than a particular length, the old file is renamed to
235
.bzr.log.old and a new file is started. Otherwise, we append to the
238
This sets the global _bzr_log_filename.
240
global _bzr_log_filename
242
def create_log_file(filename):
243
"""Create the .bzr.log file.
245
It inherits the ownership and permissions (masked by umask) from
246
the containing directory to cope better with being run under sudo
247
with $HOME still set to the user's homedir.
249
buffering = 0 # unbuffered
250
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
253
fd = os.open(filename, flags)
254
logfile = os.fdopen(fd, 'at', buffering)
257
if e.errno != errno.ENOENT:
260
flags = flags | os.O_CREAT | os.O_EXCL
262
fd = os.open(filename, flags, permissions)
263
logfile = os.fdopen(fd, 'at', buffering)
265
if e.errno != errno.EEXIST:
268
osutils.copy_ownership_from_path(filename)
272
_bzr_log_filename = _get_bzr_log_filename()
273
_rollover_trace_maybe(_bzr_log_filename)
275
bzr_log_file = create_log_file(_bzr_log_filename)
276
bzr_log_file.write('\n')
277
if bzr_log_file.tell() <= 2:
278
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
279
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
280
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
285
# If we are failing to open the log, then most likely logging has not
286
# been set up yet. So we just write to stderr rather than using
287
# 'warning()'. If we using warning(), users get the unhelpful 'no
288
# handlers registered for "bzr"' when something goes wrong on the
289
# server. (bug #503886)
290
sys.stderr.write("failed to open trace file: %s\n" % (e,))
291
# TODO: What should happen if we fail to open the trace file? Maybe the
292
# objects should be pointed at /dev/null or the equivalent? Currently
293
# returns None which will cause failures later.
297
def enable_default_logging():
298
"""Configure default logging: messages to stderr and debug to .bzr.log
300
This should only be called once per process.
302
Non-command-line programs embedding bzrlib do not need to call this. They
303
can instead either pass a file to _push_log_file, or act directly on
304
logging.getLogger("bzr").
306
Output can be redirected away by calling _push_log_file.
308
# Do this before we open the log file, so we prevent
309
# get_terminal_encoding() from mutter()ing multiple times
310
term_encoding = osutils.get_terminal_encoding()
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
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
writer_factory = codecs.getwriter(term_encoding)
323
encoded_stderr = writer_factory(sys.stderr, errors='replace')
324
stderr_handler = logging.StreamHandler(encoded_stderr)
325
stderr_handler.setLevel(logging.INFO)
326
logging.getLogger('bzr').addHandler(stderr_handler)
329
def push_log_file(to_file, log_format=None, date_format=None):
330
"""Intercept log and trace messages and send them to a file.
332
:param to_file: A file-like object to which messages will be sent.
334
:returns: A memento that should be passed to _pop_log_file to restore the
335
previously active logging.
339
new_handler = logging.StreamHandler(to_file)
340
new_handler.setLevel(logging.DEBUG)
341
if log_format is None:
342
log_format = '%(levelname)8s %(message)s'
343
new_handler.setFormatter(logging.Formatter(log_format, date_format))
344
# save and remove any existing log handlers
345
bzr_logger = logging.getLogger('bzr')
346
old_handlers = bzr_logger.handlers[:]
347
del bzr_logger.handlers[:]
348
# set that as the default logger
349
bzr_logger.addHandler(new_handler)
350
bzr_logger.setLevel(logging.DEBUG)
351
# TODO: check if any changes are needed to the root logger
353
# TODO: also probably need to save and restore the level on bzr_logger.
354
# but maybe we can avoid setting the logger level altogether, and just set
355
# the level on the handler?
357
# save the old trace file
358
old_trace_file = _trace_file
359
# send traces to the new one
360
_trace_file = to_file
361
result = new_handler, _trace_file
362
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
365
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
366
"""Undo changes to logging/tracing done by _push_log_file.
368
This flushes, but does not close the trace file.
370
Takes the memento returned from _push_log_file."""
372
_trace_file = old_trace_file
373
bzr_logger = logging.getLogger('bzr')
374
bzr_logger.removeHandler(new_handler)
375
# must be closed, otherwise logging will try to close it atexit, and the
376
# file will likely already be closed underneath.
378
bzr_logger.handlers = old_handlers
379
new_trace_file.flush()
382
def log_exception_quietly():
383
"""Log the last exception to the trace file only.
385
Used for exceptions that occur internally and that may be
386
interesting to developers but not to users. For example,
387
errors loading plugins.
389
mutter(traceback.format_exc())
392
def set_verbosity_level(level):
393
"""Set the verbosity level.
395
:param level: -ve for quiet, 0 for normal, +ve for verbose
397
global _verbosity_level
398
_verbosity_level = level
399
_update_logging_level(level < 0)
400
ui.ui_factory.be_quiet(level < 0)
403
def get_verbosity_level():
404
"""Get the verbosity level.
406
See set_verbosity_level() for values.
408
return _verbosity_level
411
def be_quiet(quiet=True):
413
set_verbosity_level(-1)
415
set_verbosity_level(0)
418
def _update_logging_level(quiet=True):
419
"""Hide INFO messages if quiet."""
421
_bzr_logger.setLevel(logging.WARNING)
423
_bzr_logger.setLevel(logging.INFO)
427
"""Is the verbosity level negative?"""
428
return _verbosity_level < 0
432
"""Is the verbosity level positive?"""
433
return _verbosity_level > 0
436
def debug_memory(message='', short=True):
437
"""Write out a memory dump."""
438
if sys.platform == 'win32':
439
from bzrlib import win32utils
440
win32utils.debug_memory_win32api(message=message, short=short)
442
_debug_memory_proc(message=message, short=short)
445
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
447
def _debug_memory_proc(message='', short=True):
449
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
453
status = status_file.read()
458
for line in status.splitlines():
462
for field in _short_fields:
463
if line.startswith(field):
468
def report_exception(exc_info, err_file):
469
"""Report an exception to err_file (typically stderr) and to .bzr.log.
471
This will show either a full traceback or a short message as appropriate.
473
:return: The appropriate exit code for this error.
475
# Log the full traceback to ~/.bzr.log
476
log_exception_quietly()
477
if 'error' in debug.debug_flags:
478
print_exception(exc_info, err_file)
479
return errors.EXIT_ERROR
480
exc_type, exc_object, exc_tb = exc_info
481
if (isinstance(exc_object, IOError)
482
and getattr(exc_object, 'errno', None) == errno.EPIPE):
483
err_file.write("bzr: broken pipe\n")
484
return errors.EXIT_ERROR
485
elif isinstance(exc_object, KeyboardInterrupt):
486
err_file.write("bzr: interrupted\n")
487
return errors.EXIT_ERROR
488
elif isinstance(exc_object, MemoryError):
489
err_file.write("bzr: out of memory\n")
490
return errors.EXIT_ERROR
491
elif isinstance(exc_object, ImportError) \
492
and str(exc_object).startswith("No module named "):
493
report_user_error(exc_info, err_file,
494
'You may need to install this Python library separately.')
495
return errors.EXIT_ERROR
496
elif not getattr(exc_object, 'internal_error', True):
497
report_user_error(exc_info, err_file)
498
return errors.EXIT_ERROR
499
elif isinstance(exc_object, (OSError, IOError)):
500
# Might be nice to catch all of these and show them as something more
501
# specific, but there are too many cases at the moment.
502
report_user_error(exc_info, err_file)
503
return errors.EXIT_ERROR
505
report_bug(exc_info, err_file)
506
return errors.EXIT_INTERNAL_ERROR
509
def print_exception(exc_info, err_file):
510
exc_type, exc_object, exc_tb = exc_info
511
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
512
exc_type.__module__, exc_type.__name__, exc_object))
514
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
517
# TODO: Should these be specially encoding the output?
518
def report_user_error(exc_info, err_file, advice=None):
519
"""Report to err_file an error that's not an internal error.
521
These don't get a traceback unless -Derror was given.
523
:param exc_info: 3-tuple from sys.exc_info()
524
:param advice: Extra advice to the user to be printed following the
527
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
529
err_file.write("%s\n" % (advice,))
532
def report_bug(exc_info, err_file):
533
"""Report an exception that probably indicates a bug in bzr"""
534
from bzrlib.crash import report_bug
535
report_bug(exc_info, err_file)
538
def _flush_stdout_stderr():
539
# installed into an atexit hook by bzrlib.initialize()
545
if e.errno in [errno.EINVAL, errno.EPIPE]:
552
# run from atexit hook
added
removed
bzrlib/trace.py
