48
49
# FIXME: Unfortunately it turns out that python's logging module
49
50
# is quite expensive, even when the message is not printed by any handlers.
50
51
# 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.
61
from bzrlib.errors import BzrError, BzrNewError
62
from bzrlib.symbol_versioning import (deprecated_function,
67
_stderr_handler = None
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
74
# configure convenient aliases for output routines
110
76
_bzr_logger = logging.getLogger('bzr')
113
78
def note(*args, **kwargs):
114
"""Output a note to the user.
116
Takes the same parameters as logging.info.
120
79
# 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
81
bzrlib.ui.ui_factory.clear_term()
127
82
_bzr_logger.info(*args, **kwargs)
130
84
def warning(*args, **kwargs):
132
86
bzrlib.ui.ui_factory.clear_term()
133
87
_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)
90
log_error = _bzr_logger.error
91
error = _bzr_logger.error
162
94
def mutter(fmt, *args):
163
95
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
97
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
215
126
if size <= 4 << 20:
217
128
old_fname = trace_fname + '.old'
218
osutils.rename(trace_fname, old_fname)
129
from osutils import rename
130
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)
135
def open_tracefile(tracefilename='~/.bzr.log'):
136
# Messages are always written to here, so that we have some
137
# information if something goes wrong. In a future version this
138
# file will be removed on successful completion.
139
global _file_handler, _bzr_log_file
142
trace_fname = os.path.join(os.path.expanduser(tracefilename))
143
_rollover_trace_maybe(trace_fname)
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
:return: A memento from push_log_file for restoring the log state.
312
start_time = osutils.format_local_date(_bzr_log_start_time,
314
# create encoded wrapper around stderr
315
bzr_log_file = _open_bzr_log()
316
if bzr_log_file is not None:
317
bzr_log_file.write(start_time.encode('utf-8') + '\n')
318
memento = push_log_file(bzr_log_file,
319
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
320
r'%Y-%m-%d %H:%M:%S')
321
# after hooking output into bzr_log, we also need to attach a stderr
322
# handler, writing only at level info and with encoding
323
term_encoding = osutils.get_terminal_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)
332
def push_log_file(to_file, log_format=None, date_format=None):
333
"""Intercept log and trace messages and send them to a file.
335
:param to_file: A file-like object to which messages will be sent.
337
:returns: A memento that should be passed to _pop_log_file to restore the
338
previously active logging.
342
new_handler = logging.StreamHandler(to_file)
343
new_handler.setLevel(logging.DEBUG)
344
if log_format is None:
345
log_format = '%(levelname)8s %(message)s'
346
new_handler.setFormatter(logging.Formatter(log_format, date_format))
347
# save and remove any existing log handlers
348
bzr_logger = logging.getLogger('bzr')
349
old_handlers = bzr_logger.handlers[:]
350
del bzr_logger.handlers[:]
351
# set that as the default logger
352
bzr_logger.addHandler(new_handler)
353
bzr_logger.setLevel(logging.DEBUG)
354
# TODO: check if any changes are needed to the root logger
356
# TODO: also probably need to save and restore the level on bzr_logger.
357
# but maybe we can avoid setting the logger level altogether, and just set
358
# the level on the handler?
360
# save the old trace file
361
old_trace_file = _trace_file
362
# send traces to the new one
363
_trace_file = to_file
364
result = new_handler, _trace_file
365
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
368
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
369
"""Undo changes to logging/tracing done by _push_log_file.
371
This flushes, but does not close the trace file (so that anything that was
374
Takes the memento returned from _push_log_file."""
376
_trace_file = old_trace_file
377
bzr_logger = logging.getLogger('bzr')
378
bzr_logger.removeHandler(new_handler)
379
# must be closed, otherwise logging will try to close it at exit, and the
380
# file will likely already be closed underneath.
382
bzr_logger.handlers = old_handlers
383
if new_trace_file is not None:
384
new_trace_file.flush()
146
#tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
147
tf = open(trace_fname, 'at', LINE_BUFFERED)
150
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
151
tf.write("you can delete or truncate this file, or include sections in\n")
152
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
153
_file_handler = logging.StreamHandler(tf)
154
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
155
datefmt = r'%a %H:%M:%S'
156
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
157
_file_handler.setLevel(logging.DEBUG)
158
logging.getLogger('').addHandler(_file_handler)
160
warning("failed to open trace file: %s" % (e))
163
@deprecated_function(zero_nine)
164
def log_exception(msg=None):
165
"""Log the last exception to stderr and the trace file.
167
The exception string representation is used as the error
168
summary, unless msg is given.
172
log_exception_quietly()
387
175
def log_exception_quietly():
388
176
"""Log the last exception to the trace file only.
390
Used for exceptions that occur internally and that may be
391
interesting to developers but not to users. For example,
178
Used for exceptions that occur internally and that may be
179
interesting to developers but not to users. For example,
392
180
errors loading plugins.
394
mutter(traceback.format_exc())
397
def set_verbosity_level(level):
398
"""Set the verbosity level.
400
:param level: -ve for quiet, 0 for normal, +ve for verbose
402
global _verbosity_level
403
_verbosity_level = level
404
_update_logging_level(level < 0)
405
ui.ui_factory.be_quiet(level < 0)
408
def get_verbosity_level():
409
"""Get the verbosity level.
411
See set_verbosity_level() for values.
413
return _verbosity_level
183
debug(traceback.format_exc())
186
def enable_default_logging():
187
"""Configure default logging to stderr and .bzr.log"""
188
# FIXME: if this is run twice, things get confused
189
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
190
_stderr_handler = logging.StreamHandler()
191
logging.getLogger('').addHandler(_stderr_handler)
192
_stderr_handler.setLevel(logging.INFO)
193
if not _file_handler:
195
_trace_file = _bzr_log_file
197
_file_handler.setLevel(logging.DEBUG)
198
_bzr_logger.setLevel(logging.DEBUG)
416
201
def be_quiet(quiet=True):
418
set_verbosity_level(-1)
420
set_verbosity_level(0)
423
def _update_logging_level(quiet=True):
424
"""Hide INFO messages if quiet."""
426
_bzr_logger.setLevel(logging.WARNING)
428
_bzr_logger.setLevel(logging.INFO)
202
global _stderr_handler, _stderr_quiet
204
_stderr_quiet = quiet
206
_stderr_handler.setLevel(logging.WARNING)
208
_stderr_handler.setLevel(logging.INFO)
432
"""Is the verbosity level negative?"""
433
return _verbosity_level < 0
437
"""Is the verbosity level positive?"""
438
return _verbosity_level > 0
441
def debug_memory(message='', short=True):
442
"""Write out a memory dump."""
443
if sys.platform == 'win32':
444
from bzrlib import win32utils
445
win32utils.debug_memory_win32api(message=message, short=short)
447
_debug_memory_proc(message=message, short=short)
450
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
452
def _debug_memory_proc(message='', short=True):
454
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
458
status = status_file.read()
463
for line in status.splitlines():
467
for field in _short_fields:
468
if line.startswith(field):
216
def disable_default_logging():
217
"""Turn off default log handlers.
219
This is intended to be used by the test framework, which doesn't
220
want leakage from the code-under-test into the main logs.
223
l = logging.getLogger('')
224
l.removeHandler(_stderr_handler)
226
l.removeHandler(_file_handler)
230
def enable_test_log(to_file):
231
"""Redirect logging to a temporary file for a test
233
returns an opaque reference that should be passed to disable_test_log
234
after the test completes.
236
disable_default_logging()
239
hdlr = logging.StreamHandler(to_file)
240
hdlr.setLevel(logging.DEBUG)
241
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
242
_bzr_logger.addHandler(hdlr)
243
_bzr_logger.setLevel(logging.DEBUG)
244
result = hdlr, _trace_file, _trace_depth
245
_trace_file = to_file
250
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
251
_bzr_logger.removeHandler(test_log_hdlr)
252
test_log_hdlr.close()
255
_trace_file = old_trace_file
256
_trace_depth = old_trace_depth
258
enable_default_logging()
473
261
def report_exception(exc_info, err_file):
474
"""Report an exception to err_file (typically stderr) and to .bzr.log.
476
This will show either a full traceback or a short message as appropriate.
478
:return: The appropriate exit code for this error.
262
exc_type, exc_object, exc_tb = exc_info
480
263
# Log the full traceback to ~/.bzr.log
481
264
log_exception_quietly()
482
if 'error' in debug.debug_flags:
483
print_exception(exc_info, err_file)
484
return errors.EXIT_ERROR
485
exc_type, exc_object, exc_tb = exc_info
486
265
if (isinstance(exc_object, IOError)
487
266
and getattr(exc_object, 'errno', None) == errno.EPIPE):
488
err_file.write("bzr: broken pipe\n")
489
return errors.EXIT_ERROR
267
print >>err_file, "bzr: broken pipe"
490
268
elif isinstance(exc_object, KeyboardInterrupt):
491
err_file.write("bzr: interrupted\n")
492
return errors.EXIT_ERROR
493
elif isinstance(exc_object, MemoryError):
494
err_file.write("bzr: out of memory\n")
495
return errors.EXIT_ERROR
496
elif isinstance(exc_object, ImportError) \
497
and str(exc_object).startswith("No module named "):
498
report_user_error(exc_info, err_file,
499
'You may need to install this Python library separately.')
500
return errors.EXIT_ERROR
501
elif not getattr(exc_object, 'internal_error', True):
269
print >>err_file, "bzr: interrupted"
270
elif getattr(exc_object, 'is_user_error', False):
502
271
report_user_error(exc_info, err_file)
503
return errors.EXIT_ERROR
504
elif isinstance(exc_object, (OSError, IOError)) or (
505
# GZ 2010-05-20: Like (exc_type is pywintypes.error) but avoid import
506
exc_type.__name__ == "error" and exc_type.__module__ == "pywintypes"):
272
elif isinstance(exc_object, (OSError, IOError)):
507
273
# Might be nice to catch all of these and show them as something more
508
274
# specific, but there are too many cases at the moment.
509
275
report_user_error(exc_info, err_file)
510
return errors.EXIT_ERROR
512
277
report_bug(exc_info, err_file)
513
return errors.EXIT_INTERNAL_ERROR
516
def print_exception(exc_info, err_file):
517
exc_type, exc_object, exc_tb = exc_info
518
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
519
exc_type.__module__, exc_type.__name__, exc_object))
521
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
524
280
# TODO: Should these be specially encoding the output?
525
def report_user_error(exc_info, err_file, advice=None):
526
"""Report to err_file an error that's not an internal error.
528
These don't get a traceback unless -Derror was given.
530
:param exc_info: 3-tuple from sys.exc_info()
531
:param advice: Extra advice to the user to be printed following the
534
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
536
err_file.write("%s\n" % (advice,))
281
def report_user_error(exc_info, err_file):
282
print >>err_file, "bzr: ERROR:", str(exc_info[1])
539
285
def report_bug(exc_info, err_file):
540
286
"""Report an exception that probably indicates a bug in bzr"""
541
from bzrlib.crash import report_bug
542
report_bug(exc_info, err_file)
545
def _flush_stdout_stderr():
546
# called from the bzrlib library finalizer returned by bzrlib.initialize()
552
if e.errno in [errno.EINVAL, errno.EPIPE]:
559
# called from the bzrlib library finalizer returned by bzrlib.initialize()
565
class Config(object):
566
"""Configuration of message tracing in bzrlib.
568
This implements the context manager protocol and should manage any global
569
variables still used. The default config used is DefaultConfig, but
570
embedded uses of bzrlib may wish to use a custom manager.
574
return self # This is bound to the 'as' clause in a with statement.
576
def __exit__(self, exc_type, exc_val, exc_tb):
577
return False # propogate exceptions.
580
class DefaultConfig(Config):
581
"""A default configuration for tracing of messages in bzrlib.
583
This implements the context manager protocol.
587
self._original_filename = _bzr_log_filename
588
self._original_state = enable_default_logging()
589
return self # This is bound to the 'as' clause in a with statement.
591
def __exit__(self, exc_type, exc_val, exc_tb):
592
pop_log_file(self._original_state)
593
global _bzr_log_filename
594
_bzr_log_filename = self._original_filename
595
return False # propogate exceptions.
288
exc_type, exc_object, exc_tb = exc_info
289
print >>err_file, "bzr: ERROR: %s.%s: %s" % (
290
exc_type.__module__, exc_type.__name__, exc_object)
292
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
294
print >>err_file, 'bzr %s on python %s (%s)' % \
296
'.'.join(map(str, sys.version_info)),
298
print >>err_file, 'arguments: %r' % sys.argv
300
print >>err_file, "** please send this report to bazaar-ng@lists.ubuntu.com"
added
removed
bzrlib/trace.py
