1
# Copyright (C) 2005-2010 Canonical Ltd
3
1
# This program is free software; you can redistribute it and/or modify
4
2
# it under the terms of the GNU General Public License as published by
5
3
# the Free Software Foundation; either version 2 of the License, or
6
4
# (at your option) any later version.
8
6
# This program is distributed in the hope that it will be useful,
9
7
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
8
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
9
# GNU General Public License for more details.
13
11
# You should have received a copy of the GNU General Public License
14
12
# 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
13
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
17
__author__ = "Martin Pool <mbp@canonical.com>"
20
"""Messages and logging for bazaar-ng
22
Nothing is actually logged unless you call bzrlib.open_tracefile().
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
"""Output a note to the user.
116
Takes the same parameters as logging.info.
120
# FIXME note always emits utf-8, regardless of the terminal encoding
122
# FIXME: clearing the ui and then going through the abstract logging
123
# framework is whack; we should probably have a logging Handler that
124
# deals with terminal output if needed.
126
bzrlib.ui.ui_factory.clear_term()
127
_bzr_logger.info(*args, **kwargs)
130
def warning(*args, **kwargs):
132
bzrlib.ui.ui_factory.clear_term()
133
_bzr_logger.warning(*args, **kwargs)
136
@deprecated_function(deprecated_in((2, 1, 0)))
137
def info(*args, **kwargs):
138
"""Deprecated: use trace.note instead."""
139
note(*args, **kwargs)
142
@deprecated_function(deprecated_in((2, 1, 0)))
143
def log_error(*args, **kwargs):
144
"""Deprecated: use bzrlib.trace.show_error instead"""
145
_bzr_logger.error(*args, **kwargs)
148
@deprecated_function(deprecated_in((2, 1, 0)))
149
def error(*args, **kwargs):
150
"""Deprecated: use bzrlib.trace.show_error instead"""
151
_bzr_logger.error(*args, **kwargs)
154
def show_error(*args, **kwargs):
155
"""Show an error message to the user.
157
Don't use this for exceptions, use report_exception instead.
159
_bzr_logger.error(*args, **kwargs)
162
def mutter(fmt, *args):
163
if _trace_file is None:
165
# XXX: Don't check this every time; instead anyone who closes the file
166
# ought to deregister it. We can tolerate None.
167
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
170
if isinstance(fmt, unicode):
171
fmt = fmt.encode('utf8')
174
# It seems that if we do ascii % (unicode, ascii) we can
175
# get a unicode cannot encode ascii error, so make sure that "fmt"
176
# is a unicode string
179
if isinstance(arg, unicode):
180
arg = arg.encode('utf8')
181
real_args.append(arg)
182
out = fmt % tuple(real_args)
186
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
187
out = timestamp + out + '\n'
188
_trace_file.write(out)
189
# there's no explicit flushing; the file is typically line buffered.
192
def mutter_callsite(stacklevel, fmt, *args):
193
"""Perform a mutter of fmt and args, logging the call trace.
195
:param stacklevel: The number of frames to show. None will show all
197
:param fmt: The format string to pass to mutter.
198
:param args: A list of substitution variables.
201
if stacklevel is None:
204
limit = stacklevel + 1
205
traceback.print_stack(limit=limit, file=outf)
206
formatted_lines = outf.getvalue().splitlines()
207
formatted_stack = '\n'.join(formatted_lines[:-2])
208
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
28
######################################################################
29
# messages and logging
31
global _tracefile, _starttime
34
# used to have % (os.environ['USER'], time.time(), os.getpid()), 'w')
37
# If false, notes also go to stdout; should replace this with --silent
42
# fix this if we ever fork within python
44
_logprefix = '[%d] ' % _mypid
47
def _write_trace(msg):
49
_tracefile.write(_logprefix + msg + '\n')
53
sys.stderr.write('bzr: warning: ' + msg + '\n')
54
_write_trace('warning: ' + msg)
61
b = '* ' + str(msg) + '\n'
64
_write_trace('note: ' + msg)
68
sys.stderr.write(msg + '\n')
211
72
def _rollover_trace_maybe(trace_fname):
215
76
if size <= 4 << 20:
217
78
old_fname = trace_fname + '.old'
218
osutils.rename(trace_fname, old_fname)
81
# must remove before rename on windows
87
# might fail if in use on windows
88
os.rename(trace_fname, old_fname)
223
def _get_bzr_log_filename():
224
bzr_log = os.environ.get('BZR_LOG')
227
home = os.environ.get('BZR_HOME')
229
if sys.platform == 'win32':
230
from bzrlib import win32utils
231
home = win32utils.get_home_location()
233
home = os.path.expanduser('~')
234
return os.path.join(home, '.bzr.log')
238
"""Open the .bzr.log trace file.
240
If the log is more than a particular length, the old file is renamed to
241
.bzr.log.old and a new file is started. Otherwise, we append to the
244
This sets the global _bzr_log_filename.
246
global _bzr_log_filename
248
def _open_or_create_log_file(filename):
249
"""Open existing log file, or create with ownership and permissions
251
It inherits the ownership and permissions (masked by umask) from
252
the containing directory to cope better with being run under sudo
253
with $HOME still set to the user's homedir.
255
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
258
fd = os.open(filename, flags)
261
if e.errno != errno.ENOENT:
264
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
266
if e.errno != errno.EEXIST:
269
osutils.copy_ownership_from_path(filename)
271
return os.fdopen(fd, 'at', 0) # unbuffered
274
_bzr_log_filename = _get_bzr_log_filename()
275
_rollover_trace_maybe(_bzr_log_filename)
277
bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
278
bzr_log_file.write('\n')
279
if bzr_log_file.tell() <= 2:
280
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
281
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
282
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
286
except EnvironmentError, e:
287
# If we are failing to open the log, then most likely logging has not
288
# been set up yet. So we just write to stderr rather than using
289
# 'warning()'. If we using warning(), users get the unhelpful 'no
290
# handlers registered for "bzr"' when something goes wrong on the
291
# server. (bug #503886)
292
sys.stderr.write("failed to open trace file: %s\n" % (e,))
293
# TODO: What should happen if we fail to open the trace file? Maybe the
294
# objects should be pointed at /dev/null or the equivalent? Currently
295
# returns None which will cause failures later.
299
def enable_default_logging():
300
"""Configure default logging: messages to stderr and debug to .bzr.log
302
This should only be called once per process.
304
Non-command-line programs embedding bzrlib do not need to call this. They
305
can instead either pass a file to _push_log_file, or act directly on
306
logging.getLogger("bzr").
308
Output can be redirected away by calling _push_log_file.
310
# Do this before we open the log file, so we prevent
311
# get_terminal_encoding() from mutter()ing multiple times
312
term_encoding = osutils.get_terminal_encoding()
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
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
writer_factory = codecs.getwriter(term_encoding)
325
encoded_stderr = writer_factory(sys.stderr, errors='replace')
326
stderr_handler = logging.StreamHandler(encoded_stderr)
327
stderr_handler.setLevel(logging.INFO)
328
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.
372
Takes the memento returned from _push_log_file."""
374
_trace_file = old_trace_file
375
bzr_logger = logging.getLogger('bzr')
376
bzr_logger.removeHandler(new_handler)
377
# must be closed, otherwise logging will try to close it atexit, and the
378
# file will likely already be closed underneath.
380
bzr_logger.handlers = old_handlers
381
new_trace_file.flush()
384
def log_exception_quietly():
385
"""Log the last exception to the trace file only.
387
Used for exceptions that occur internally and that may be
388
interesting to developers but not to users. For example,
389
errors loading plugins.
391
mutter(traceback.format_exc())
394
def set_verbosity_level(level):
395
"""Set the verbosity level.
397
:param level: -ve for quiet, 0 for normal, +ve for verbose
399
global _verbosity_level
400
_verbosity_level = level
401
_update_logging_level(level < 0)
402
ui.ui_factory.be_quiet(level < 0)
405
def get_verbosity_level():
406
"""Get the verbosity level.
408
See set_verbosity_level() for values.
410
return _verbosity_level
413
def be_quiet(quiet=True):
415
set_verbosity_level(-1)
417
set_verbosity_level(0)
420
def _update_logging_level(quiet=True):
421
"""Hide INFO messages if quiet."""
423
_bzr_logger.setLevel(logging.WARNING)
425
_bzr_logger.setLevel(logging.INFO)
429
"""Is the verbosity level negative?"""
430
return _verbosity_level < 0
434
"""Is the verbosity level positive?"""
435
return _verbosity_level > 0
438
def debug_memory(message='', short=True):
439
"""Write out a memory dump."""
440
if sys.platform == 'win32':
441
from bzrlib import win32utils
442
win32utils.debug_memory_win32api(message=message, short=short)
444
_debug_memory_proc(message=message, short=short)
447
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
449
def _debug_memory_proc(message='', short=True):
451
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
455
status = status_file.read()
460
for line in status.splitlines():
464
for field in _short_fields:
465
if line.startswith(field):
470
def report_exception(exc_info, err_file):
471
"""Report an exception to err_file (typically stderr) and to .bzr.log.
473
This will show either a full traceback or a short message as appropriate.
475
:return: The appropriate exit code for this error.
477
# Log the full traceback to ~/.bzr.log
478
log_exception_quietly()
479
if 'error' in debug.debug_flags:
480
print_exception(exc_info, err_file)
481
return errors.EXIT_ERROR
482
exc_type, exc_object, exc_tb = exc_info
483
if (isinstance(exc_object, IOError)
484
and getattr(exc_object, 'errno', None) == errno.EPIPE):
485
err_file.write("bzr: broken pipe\n")
486
return errors.EXIT_ERROR
487
elif isinstance(exc_object, KeyboardInterrupt):
488
err_file.write("bzr: interrupted\n")
489
return errors.EXIT_ERROR
490
elif isinstance(exc_object, MemoryError):
491
err_file.write("bzr: out of memory\n")
492
return errors.EXIT_ERROR
493
elif isinstance(exc_object, ImportError) \
494
and str(exc_object).startswith("No module named "):
495
report_user_error(exc_info, err_file,
496
'You may need to install this Python library separately.')
497
return errors.EXIT_ERROR
498
elif not getattr(exc_object, 'internal_error', True):
499
report_user_error(exc_info, err_file)
500
return errors.EXIT_ERROR
501
elif isinstance(exc_object, (OSError, IOError)):
502
# Might be nice to catch all of these and show them as something more
503
# specific, but there are too many cases at the moment.
504
report_user_error(exc_info, err_file)
505
return errors.EXIT_ERROR
507
report_bug(exc_info, err_file)
508
return errors.EXIT_INTERNAL_ERROR
511
def print_exception(exc_info, err_file):
512
exc_type, exc_object, exc_tb = exc_info
513
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
514
exc_type.__module__, exc_type.__name__, exc_object))
516
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
519
# TODO: Should these be specially encoding the output?
520
def report_user_error(exc_info, err_file, advice=None):
521
"""Report to err_file an error that's not an internal error.
523
These don't get a traceback unless -Derror was given.
525
:param exc_info: 3-tuple from sys.exc_info()
526
:param advice: Extra advice to the user to be printed following the
529
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
531
err_file.write("%s\n" % (advice,))
534
def report_bug(exc_info, err_file):
535
"""Report an exception that probably indicates a bug in bzr"""
536
from bzrlib.crash import report_bug
537
report_bug(exc_info, err_file)
540
def _flush_stdout_stderr():
541
# installed into an atexit hook by bzrlib.initialize()
96
def open_tracefile(argv=[], tracefilename='~/.bzr.log'):
97
# Messages are always written to here, so that we have some
98
# information if something goes wrong. In a future version this
99
# file will be removed on successful completion.
100
global _starttime, _tracefile
103
_starttime = os.times()[4]
105
trace_fname = os.path.join(os.path.expanduser(tracefilename))
106
_rollover_trace_maybe(trace_fname)
108
# buffering=1 means line buffered
110
_tracefile = codecs.open(trace_fname, 'at', 'utf8', buffering=1)
113
if os.fstat(t.fileno())[stat.ST_SIZE] == 0:
114
t.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
115
t.write("you can delete or truncate this file, or include sections in\n")
116
t.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
119
_write_trace('bzr %s invoked on python %s (%s)'
120
% (bzrlib.__version__,
121
'.'.join(map(str, sys.version_info)),
124
_write_trace(' arguments: %r' % argv)
125
_write_trace(' working dir: ' + os.getcwdu())
545
126
except IOError, e:
547
if e.errno in [errno.EINVAL, errno.EPIPE]:
554
# run from atexit hook
127
warning("failed to open trace file: %s" % (e))
131
mutter("finished, %.3fu/%.3fs cpu, %.3fu/%.3fs cum, %.3f elapsed"
132
% (times[:4] + ((times[4] - _starttime),)))
137
"""Log the last exception into the trace file."""
139
s = cgitb.text(sys.exc_info())
140
for l in s.split('\n'):
added
removed
bzrlib/trace.py
