49
48
# FIXME: Unfortunately it turns out that python's logging module
50
49
# is quite expensive, even when the message is not printed by any handlers.
51
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
60
from bzrlib.errors import BzrError, BzrNewError
61
from bzrlib.symbol_versioning import (deprecated_function,
66
_stderr_handler = None
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.
73
# configure convenient aliases for output routines
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
75
111
_bzr_logger = logging.getLogger('bzr')
77
114
def note(*args, **kwargs):
115
"""Output a note to the user.
117
Takes the same parameters as logging.info.
78
121
# FIXME note always emits utf-8, regardless of the terminal encoding
80
bzrlib.ui.ui_factory.clear_term()
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.
126
ui.ui_factory.clear_term()
81
127
_bzr_logger.info(*args, **kwargs)
83
130
def warning(*args, **kwargs):
85
bzrlib.ui.ui_factory.clear_term()
131
ui.ui_factory.clear_term()
86
132
_bzr_logger.warning(*args, **kwargs)
89
log_error = _bzr_logger.error
90
error = _bzr_logger.error
135
@deprecated_function(deprecated_in((2, 1, 0)))
136
def info(*args, **kwargs):
137
"""Deprecated: use trace.note instead."""
138
note(*args, **kwargs)
141
@deprecated_function(deprecated_in((2, 1, 0)))
142
def log_error(*args, **kwargs):
143
"""Deprecated: use bzrlib.trace.show_error instead"""
144
_bzr_logger.error(*args, **kwargs)
147
@deprecated_function(deprecated_in((2, 1, 0)))
148
def error(*args, **kwargs):
149
"""Deprecated: use bzrlib.trace.show_error instead"""
150
_bzr_logger.error(*args, **kwargs)
153
def show_error(*args, **kwargs):
154
"""Show an error message to the user.
156
Don't use this for exceptions, use report_exception instead.
158
_bzr_logger.error(*args, **kwargs)
93
161
def mutter(fmt, *args):
94
162
if _trace_file is None:
96
if hasattr(_trace_file, 'closed') and _trace_file.closed:
164
# XXX: Don't check this every time; instead anyone who closes the file
165
# ought to deregister it. We can tolerate None.
166
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
99
169
if isinstance(fmt, unicode):
125
214
if size <= 4 << 20:
127
216
old_fname = trace_fname + '.old'
128
from osutils import rename
129
rename(trace_fname, old_fname)
217
osutils.rename(trace_fname, old_fname)
134
def open_tracefile(tracefilename='~/.bzr.log'):
135
# Messages are always written to here, so that we have some
136
# information if something goes wrong. In a future version this
137
# file will be removed on successful completion.
138
global _file_handler, _bzr_log_file
141
trace_fname = os.path.join(os.path.expanduser(tracefilename))
142
_rollover_trace_maybe(trace_fname)
222
def _get_bzr_log_filename():
223
bzr_log = os.environ.get('BZR_LOG')
226
home = os.environ.get('BZR_HOME')
228
if sys.platform == 'win32':
229
from bzrlib import win32utils
230
home = win32utils.get_home_location()
232
home = os.path.expanduser('~')
233
return os.path.join(home, '.bzr.log')
237
"""Open the .bzr.log trace file.
239
If the log is more than a particular length, the old file is renamed to
240
.bzr.log.old and a new file is started. Otherwise, we append to the
243
This sets the global _bzr_log_filename.
245
global _bzr_log_filename
247
def _open_or_create_log_file(filename):
248
"""Open existing log file, or create with ownership and permissions
250
It inherits the ownership and permissions (masked by umask) from
251
the containing directory to cope better with being run under sudo
252
with $HOME still set to the user's homedir.
254
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
257
fd = os.open(filename, flags)
260
if e.errno != errno.ENOENT:
263
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
265
if e.errno != errno.EEXIST:
268
osutils.copy_ownership_from_path(filename)
270
return os.fdopen(fd, 'at', 0) # unbuffered
273
_bzr_log_filename = _get_bzr_log_filename()
274
_rollover_trace_maybe(_bzr_log_filename)
145
#tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
146
tf = open(trace_fname, 'at', LINE_BUFFERED)
149
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
150
tf.write("you can delete or truncate this file, or include sections in\n")
151
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
152
_file_handler = logging.StreamHandler(tf)
153
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
154
datefmt = r'%a %H:%M:%S'
155
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
156
_file_handler.setLevel(logging.DEBUG)
157
logging.getLogger('').addHandler(_file_handler)
159
warning("failed to open trace file: %s" % (e))
162
@deprecated_function(zero_nine)
163
def log_exception(msg=None):
164
"""Log the last exception to stderr and the trace file.
166
The exception string representation is used as the error
167
summary, unless msg is given.
172
exc_str = format_exception_short(sys.exc_info())
174
log_exception_quietly()
276
bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
277
bzr_log_file.write('\n')
278
if bzr_log_file.tell() <= 2:
279
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
280
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
281
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
285
except EnvironmentError, e:
286
# If we are failing to open the log, then most likely logging has not
287
# been set up yet. So we just write to stderr rather than using
288
# 'warning()'. If we using warning(), users get the unhelpful 'no
289
# handlers registered for "bzr"' when something goes wrong on the
290
# server. (bug #503886)
291
sys.stderr.write("failed to open trace file: %s\n" % (e,))
292
# TODO: What should happen if we fail to open the trace file? Maybe the
293
# objects should be pointed at /dev/null or the equivalent? Currently
294
# returns None which will cause failures later.
298
def enable_default_logging():
299
"""Configure default logging: messages to stderr and debug to .bzr.log
301
This should only be called once per process.
303
Non-command-line programs embedding bzrlib do not need to call this. They
304
can instead either pass a file to _push_log_file, or act directly on
305
logging.getLogger("bzr").
307
Output can be redirected away by calling _push_log_file.
309
:return: A memento from push_log_file for restoring the log state.
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
memento = 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
term_encoding = osutils.get_terminal_encoding()
323
writer_factory = codecs.getwriter(term_encoding)
324
encoded_stderr = writer_factory(sys.stderr, errors='replace')
325
stderr_handler = logging.StreamHandler(encoded_stderr)
326
stderr_handler.setLevel(logging.INFO)
327
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 (so that anything that was
373
Takes the memento returned from _push_log_file."""
375
_trace_file = old_trace_file
376
bzr_logger = logging.getLogger('bzr')
377
bzr_logger.removeHandler(new_handler)
378
# must be closed, otherwise logging will try to close it at exit, and the
379
# file will likely already be closed underneath.
381
bzr_logger.handlers = old_handlers
382
if new_trace_file is not None:
383
new_trace_file.flush()
177
386
def log_exception_quietly():
178
387
"""Log the last exception to the trace file only.
180
Used for exceptions that occur internally and that may be
181
interesting to developers but not to users. For example,
389
Used for exceptions that occur internally and that may be
390
interesting to developers but not to users. For example,
182
391
errors loading plugins.
185
debug(traceback.format_exc())
188
def enable_default_logging():
189
"""Configure default logging to stderr and .bzr.log"""
190
# FIXME: if this is run twice, things get confused
191
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
192
_stderr_handler = logging.StreamHandler()
193
logging.getLogger('').addHandler(_stderr_handler)
194
_stderr_handler.setLevel(logging.INFO)
195
if not _file_handler:
197
_trace_file = _bzr_log_file
199
_file_handler.setLevel(logging.DEBUG)
200
_bzr_logger.setLevel(logging.DEBUG)
393
mutter(traceback.format_exc())
396
def set_verbosity_level(level):
397
"""Set the verbosity level.
399
:param level: -ve for quiet, 0 for normal, +ve for verbose
401
global _verbosity_level
402
_verbosity_level = level
403
_update_logging_level(level < 0)
404
ui.ui_factory.be_quiet(level < 0)
407
def get_verbosity_level():
408
"""Get the verbosity level.
410
See set_verbosity_level() for values.
412
return _verbosity_level
203
415
def be_quiet(quiet=True):
204
global _stderr_handler, _stderr_quiet
206
_stderr_quiet = quiet
208
_stderr_handler.setLevel(logging.WARNING)
210
_stderr_handler.setLevel(logging.INFO)
417
set_verbosity_level(-1)
419
set_verbosity_level(0)
422
def _update_logging_level(quiet=True):
423
"""Hide INFO messages if quiet."""
425
_bzr_logger.setLevel(logging.WARNING)
427
_bzr_logger.setLevel(logging.INFO)
218
def disable_default_logging():
219
"""Turn off default log handlers.
221
This is intended to be used by the test framework, which doesn't
222
want leakage from the code-under-test into the main logs.
225
l = logging.getLogger('')
226
l.removeHandler(_stderr_handler)
228
l.removeHandler(_file_handler)
232
def enable_test_log(to_file):
233
"""Redirect logging to a temporary file for a test
235
returns an opaque reference that should be passed to disable_test_log
236
after the test completes.
238
disable_default_logging()
241
hdlr = logging.StreamHandler(to_file)
242
hdlr.setLevel(logging.DEBUG)
243
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
244
_bzr_logger.addHandler(hdlr)
245
_bzr_logger.setLevel(logging.DEBUG)
246
result = hdlr, _trace_file, _trace_depth
247
_trace_file = to_file
252
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
253
_bzr_logger.removeHandler(test_log_hdlr)
254
test_log_hdlr.close()
257
_trace_file = old_trace_file
258
_trace_depth = old_trace_depth
260
enable_default_logging()
431
"""Is the verbosity level negative?"""
432
return _verbosity_level < 0
436
"""Is the verbosity level positive?"""
437
return _verbosity_level > 0
440
def debug_memory(message='', short=True):
441
"""Write out a memory dump."""
442
if sys.platform == 'win32':
443
from bzrlib import win32utils
444
win32utils.debug_memory_win32api(message=message, short=short)
446
_debug_memory_proc(message=message, short=short)
449
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
451
def _debug_memory_proc(message='', short=True):
453
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
457
status = status_file.read()
462
for line in status.splitlines():
466
for field in _short_fields:
467
if line.startswith(field):
471
def _dump_memory_usage(err_file):
474
fd, name = tempfile.mkstemp(prefix="bzr_memdump", suffix=".json")
475
dump_file = os.fdopen(fd, 'w')
476
from meliae import scanner
477
scanner.dump_gc_objects(dump_file)
478
err_file.write("Memory dumped to %s\n" % name)
480
err_file.write("Dumping memory requires meliae module.\n")
481
log_exception_quietly()
483
err_file.write("Exception while dumping memory.\n")
484
log_exception_quietly()
486
if dump_file is not None:
263
491
def report_exception(exc_info, err_file):
264
exc_type, exc_object, exc_tb = exc_info
492
"""Report an exception to err_file (typically stderr) and to .bzr.log.
494
This will show either a full traceback or a short message as appropriate.
496
:return: The appropriate exit code for this error.
265
498
# Log the full traceback to ~/.bzr.log
266
499
log_exception_quietly()
500
if 'error' in debug.debug_flags:
501
print_exception(exc_info, err_file)
502
return errors.EXIT_ERROR
503
exc_type, exc_object, exc_tb = exc_info
267
504
if (isinstance(exc_object, IOError)
268
505
and getattr(exc_object, 'errno', None) == errno.EPIPE):
269
print >>err_file, "bzr: broken pipe"
506
err_file.write("bzr: broken pipe\n")
507
return errors.EXIT_ERROR
270
508
elif isinstance(exc_object, KeyboardInterrupt):
271
print >>err_file, "bzr: interrupted"
272
elif getattr(exc_object, 'is_user_error', False):
509
err_file.write("bzr: interrupted\n")
510
return errors.EXIT_ERROR
511
elif isinstance(exc_object, MemoryError):
512
err_file.write("bzr: out of memory\n")
513
if 'mem_dump' in debug.debug_flags:
514
_dump_memory_usage(err_file)
516
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
517
return errors.EXIT_ERROR
518
elif isinstance(exc_object, ImportError) \
519
and str(exc_object).startswith("No module named "):
520
report_user_error(exc_info, err_file,
521
'You may need to install this Python library separately.')
522
return errors.EXIT_ERROR
523
elif not getattr(exc_object, 'internal_error', True):
273
524
report_user_error(exc_info, err_file)
274
elif isinstance(exc_object, (OSError, IOError)):
525
return errors.EXIT_ERROR
526
elif isinstance(exc_object, (OSError, IOError)) or (
527
# GZ 2010-05-20: Like (exc_type is pywintypes.error) but avoid import
528
exc_type.__name__ == "error" and exc_type.__module__ == "pywintypes"):
275
529
# Might be nice to catch all of these and show them as something more
276
530
# specific, but there are too many cases at the moment.
277
531
report_user_error(exc_info, err_file)
532
return errors.EXIT_ERROR
279
534
report_bug(exc_info, err_file)
535
return errors.EXIT_INTERNAL_ERROR
538
def print_exception(exc_info, err_file):
539
exc_type, exc_object, exc_tb = exc_info
540
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
541
exc_type.__module__, exc_type.__name__, exc_object))
543
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
282
546
# TODO: Should these be specially encoding the output?
283
def report_user_error(exc_info, err_file):
284
print >>err_file, "bzr: ERROR:", str(exc_info[1])
547
def report_user_error(exc_info, err_file, advice=None):
548
"""Report to err_file an error that's not an internal error.
550
These don't get a traceback unless -Derror was given.
552
:param exc_info: 3-tuple from sys.exc_info()
553
:param advice: Extra advice to the user to be printed following the
556
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
558
err_file.write("%s\n" % (advice,))
287
561
def report_bug(exc_info, err_file):
288
562
"""Report an exception that probably indicates a bug in bzr"""
290
exc_type, exc_object, exc_tb = exc_info
291
print >>err_file, "bzr: ERROR: %s: %s" % (exc_type, exc_object)
293
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
295
print >>err_file, 'bzr %s on python %s (%s)' % \
297
'.'.join(map(str, sys.version_info)),
299
print >>err_file, 'arguments: %r' % sys.argv
301
print >>err_file, "** please send this report to bazaar-ng@lists.ubuntu.com"
563
from bzrlib.crash import report_bug
564
report_bug(exc_info, err_file)
567
def _flush_stdout_stderr():
568
# called from the bzrlib library finalizer returned by bzrlib.initialize()
574
if e.errno in [errno.EINVAL, errno.EPIPE]:
581
# called from the bzrlib library finalizer returned by bzrlib.initialize()
587
class Config(object):
588
"""Configuration of message tracing in bzrlib.
590
This implements the context manager protocol and should manage any global
591
variables still used. The default config used is DefaultConfig, but
592
embedded uses of bzrlib may wish to use a custom manager.
596
return self # This is bound to the 'as' clause in a with statement.
598
def __exit__(self, exc_type, exc_val, exc_tb):
599
return False # propogate exceptions.
602
class DefaultConfig(Config):
603
"""A default configuration for tracing of messages in bzrlib.
605
This implements the context manager protocol.
609
self._original_filename = _bzr_log_filename
610
self._original_state = enable_default_logging()
611
return self # This is bound to the 'as' clause in a with statement.
613
def __exit__(self, exc_type, exc_val, exc_tb):
614
pop_log_file(self._original_state)
615
global _bzr_log_filename
616
_bzr_log_filename = self._original_filename
617
return False # propogate exceptions.
added
removed
bzrlib/trace.py
