2
# -*- coding: UTF-8 -*-
1
# Copyright (C) 2005-2010 Canonical Ltd
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
6
5
# the Free Software Foundation; either version 2 of the License, or
7
6
# (at your option) any later version.
9
8
# This program is distributed in the hope that it will be useful,
10
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
11
# GNU General Public License for more details.
14
13
# You should have received a copy of the GNU General Public License
15
14
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
20
__author__ = "Martin Pool <mbp@canonical.com>"
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
25
######################################################################
26
# messages and logging
28
# Messages are always written to here, so that we have some
29
# information if something goes wrong. In a future version this
30
# file will be removed on successful completion.
31
_tracefile = file('.bzr.log', 'at')
33
## TODO: If --verbose is given then write to both stderr and
34
## _tracefile; perhaps replace _tracefile with a tee thing.
36
# used to have % (os.environ['USER'], time.time(), os.getpid()), 'w')
39
# If false, notes also go to stdout; should replace this with --silent
48
_tracefile.write('\n')
51
sys.stderr.write('- ' + msg + '\n')
55
b = '* ' + str(msg) + '\n'
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 _open_or_create_log_file(filename):
243
"""Open existing log file, or create with ownership and permissions
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
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
252
fd = os.open(filename, flags)
255
if e.errno != errno.ENOENT:
258
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
260
if e.errno != errno.EEXIST:
263
osutils.copy_ownership_from_path(filename)
265
return os.fdopen(fd, 'at', 0) # unbuffered
268
_bzr_log_filename = _get_bzr_log_filename()
269
_rollover_trace_maybe(_bzr_log_filename)
271
bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
272
bzr_log_file.write('\n')
273
if bzr_log_file.tell() <= 2:
274
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
275
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
276
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
280
except EnvironmentError, e:
281
# If we are failing to open the log, then most likely logging has not
282
# been set up yet. So we just write to stderr rather than using
283
# 'warning()'. If we using warning(), users get the unhelpful 'no
284
# handlers registered for "bzr"' when something goes wrong on the
285
# server. (bug #503886)
286
sys.stderr.write("failed to open trace file: %s\n" % (e,))
287
# TODO: What should happen if we fail to open the trace file? Maybe the
288
# objects should be pointed at /dev/null or the equivalent? Currently
289
# returns None which will cause failures later.
293
def enable_default_logging():
294
"""Configure default logging: messages to stderr and debug to .bzr.log
296
This should only be called once per process.
298
Non-command-line programs embedding bzrlib do not need to call this. They
299
can instead either pass a file to _push_log_file, or act directly on
300
logging.getLogger("bzr").
302
Output can be redirected away by calling _push_log_file.
304
# Do this before we open the log file, so we prevent
305
# get_terminal_encoding() from mutter()ing multiple times
306
term_encoding = osutils.get_terminal_encoding()
307
start_time = osutils.format_local_date(_bzr_log_start_time,
309
# create encoded wrapper around stderr
310
bzr_log_file = _open_bzr_log()
311
if bzr_log_file is not None:
312
bzr_log_file.write(start_time.encode('utf-8') + '\n')
313
push_log_file(bzr_log_file,
314
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
315
r'%Y-%m-%d %H:%M:%S')
316
# after hooking output into bzr_log, we also need to attach a stderr
317
# handler, writing only at level info and with encoding
318
writer_factory = codecs.getwriter(term_encoding)
319
encoded_stderr = writer_factory(sys.stderr, errors='replace')
320
stderr_handler = logging.StreamHandler(encoded_stderr)
321
stderr_handler.setLevel(logging.INFO)
322
logging.getLogger('bzr').addHandler(stderr_handler)
325
def push_log_file(to_file, log_format=None, date_format=None):
326
"""Intercept log and trace messages and send them to a file.
328
:param to_file: A file-like object to which messages will be sent.
330
:returns: A memento that should be passed to _pop_log_file to restore the
331
previously active logging.
335
new_handler = logging.StreamHandler(to_file)
336
new_handler.setLevel(logging.DEBUG)
337
if log_format is None:
338
log_format = '%(levelname)8s %(message)s'
339
new_handler.setFormatter(logging.Formatter(log_format, date_format))
340
# save and remove any existing log handlers
341
bzr_logger = logging.getLogger('bzr')
342
old_handlers = bzr_logger.handlers[:]
343
del bzr_logger.handlers[:]
344
# set that as the default logger
345
bzr_logger.addHandler(new_handler)
346
bzr_logger.setLevel(logging.DEBUG)
347
# TODO: check if any changes are needed to the root logger
349
# TODO: also probably need to save and restore the level on bzr_logger.
350
# but maybe we can avoid setting the logger level altogether, and just set
351
# the level on the handler?
353
# save the old trace file
354
old_trace_file = _trace_file
355
# send traces to the new one
356
_trace_file = to_file
357
result = new_handler, _trace_file
358
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
361
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
362
"""Undo changes to logging/tracing done by _push_log_file.
364
This flushes, but does not close the trace file.
366
Takes the memento returned from _push_log_file."""
368
_trace_file = old_trace_file
369
bzr_logger = logging.getLogger('bzr')
370
bzr_logger.removeHandler(new_handler)
371
# must be closed, otherwise logging will try to close it atexit, and the
372
# file will likely already be closed underneath.
374
bzr_logger.handlers = old_handlers
375
new_trace_file.flush()
378
def log_exception_quietly():
379
"""Log the last exception to the trace file only.
381
Used for exceptions that occur internally and that may be
382
interesting to developers but not to users. For example,
383
errors loading plugins.
385
mutter(traceback.format_exc())
388
def set_verbosity_level(level):
389
"""Set the verbosity level.
391
:param level: -ve for quiet, 0 for normal, +ve for verbose
393
global _verbosity_level
394
_verbosity_level = level
395
_update_logging_level(level < 0)
396
ui.ui_factory.be_quiet(level < 0)
399
def get_verbosity_level():
400
"""Get the verbosity level.
402
See set_verbosity_level() for values.
404
return _verbosity_level
407
def be_quiet(quiet=True):
409
set_verbosity_level(-1)
411
set_verbosity_level(0)
414
def _update_logging_level(quiet=True):
415
"""Hide INFO messages if quiet."""
417
_bzr_logger.setLevel(logging.WARNING)
419
_bzr_logger.setLevel(logging.INFO)
423
"""Is the verbosity level negative?"""
424
return _verbosity_level < 0
428
"""Is the verbosity level positive?"""
429
return _verbosity_level > 0
432
def debug_memory(message='', short=True):
433
"""Write out a memory dump."""
434
if sys.platform == 'win32':
435
from bzrlib import win32utils
436
win32utils.debug_memory_win32api(message=message, short=short)
438
_debug_memory_proc(message=message, short=short)
441
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
443
def _debug_memory_proc(message='', short=True):
445
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
449
status = status_file.read()
454
for line in status.splitlines():
458
for field in _short_fields:
459
if line.startswith(field):
464
def report_exception(exc_info, err_file):
465
"""Report an exception to err_file (typically stderr) and to .bzr.log.
467
This will show either a full traceback or a short message as appropriate.
469
:return: The appropriate exit code for this error.
471
# Log the full traceback to ~/.bzr.log
472
log_exception_quietly()
473
if 'error' in debug.debug_flags:
474
print_exception(exc_info, err_file)
475
return errors.EXIT_ERROR
476
exc_type, exc_object, exc_tb = exc_info
477
if (isinstance(exc_object, IOError)
478
and getattr(exc_object, 'errno', None) == errno.EPIPE):
479
err_file.write("bzr: broken pipe\n")
480
return errors.EXIT_ERROR
481
elif isinstance(exc_object, KeyboardInterrupt):
482
err_file.write("bzr: interrupted\n")
483
return errors.EXIT_ERROR
484
elif isinstance(exc_object, MemoryError):
485
err_file.write("bzr: out of memory\n")
486
return errors.EXIT_ERROR
487
elif isinstance(exc_object, ImportError) \
488
and str(exc_object).startswith("No module named "):
489
report_user_error(exc_info, err_file,
490
'You may need to install this Python library separately.')
491
return errors.EXIT_ERROR
492
elif not getattr(exc_object, 'internal_error', True):
493
report_user_error(exc_info, err_file)
494
return errors.EXIT_ERROR
495
elif isinstance(exc_object, (OSError, IOError)):
496
# Might be nice to catch all of these and show them as something more
497
# specific, but there are too many cases at the moment.
498
report_user_error(exc_info, err_file)
499
return errors.EXIT_ERROR
501
report_bug(exc_info, err_file)
502
return errors.EXIT_INTERNAL_ERROR
505
def print_exception(exc_info, err_file):
506
exc_type, exc_object, exc_tb = exc_info
507
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
508
exc_type.__module__, exc_type.__name__, exc_object))
510
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
513
# TODO: Should these be specially encoding the output?
514
def report_user_error(exc_info, err_file, advice=None):
515
"""Report to err_file an error that's not an internal error.
517
These don't get a traceback unless -Derror was given.
519
:param exc_info: 3-tuple from sys.exc_info()
520
:param advice: Extra advice to the user to be printed following the
523
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
525
err_file.write("%s\n" % (advice,))
528
def report_bug(exc_info, err_file):
529
"""Report an exception that probably indicates a bug in bzr"""
530
from bzrlib.crash import report_bug
531
report_bug(exc_info, err_file)
534
def _flush_stdout_stderr():
535
# installed into an atexit hook by bzrlib.initialize()
541
if e.errno in [errno.EINVAL, errno.EPIPE]:
548
# run from atexit hook
added
removed
bzrlib/trace.py
