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
57
from bzrlib.lazy_import import lazy_import
64
58
lazy_import(globals(), """
65
61
from cStringIO import StringIO
73
from bzrlib.symbol_versioning import (
65
from bzrlib.symbol_versioning import (deprecated_function,
78
69
lazy_import(globals(), """
70
from bzrlib import debug
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.
74
_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
82
# configure convenient aliases for output routines
110
84
_bzr_logger = logging.getLogger('bzr')
113
86
def note(*args, **kwargs):
114
"""Output a note to the user.
116
Takes the same parameters as logging.info.
119
87
# FIXME note always emits utf-8, regardless of the terminal encoding
121
# FIXME: clearing the ui and then going through the abstract logging
122
# framework is whack; we should probably have a logging Handler that
123
# deals with terminal output if needed.
125
89
bzrlib.ui.ui_factory.clear_term()
126
90
_bzr_logger.info(*args, **kwargs)
129
92
def warning(*args, **kwargs):
131
94
bzrlib.ui.ui_factory.clear_term()
132
95
_bzr_logger.warning(*args, **kwargs)
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)
98
log_error = _bzr_logger.error
99
error = _bzr_logger.error
161
102
def mutter(fmt, *args):
162
103
if _trace_file is None:
164
# XXX: Don't check this every time; instead anyone who closes the file
165
# ought to deregister it. We can tolerate None.
166
105
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
214
133
if size <= 4 << 20:
216
135
old_fname = trace_fname + '.old'
217
osutils.rename(trace_fname, old_fname)
136
from osutils import rename
137
rename(trace_fname, old_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)
142
def open_tracefile(tracefilename='~/.bzr.log'):
143
# Messages are always written to here, so that we have some
144
# information if something goes wrong. In a future version this
145
# file will be removed on successful completion.
146
global _file_handler, _bzr_log_file
149
trace_fname = os.path.join(os.path.expanduser(tracefilename))
150
_rollover_trace_maybe(trace_fname)
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
# Do this before we open the log file, so we prevent
310
# get_terminal_encoding() from mutter()ing multiple times
311
term_encoding = osutils.get_terminal_encoding()
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
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
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)
330
def push_log_file(to_file, log_format=None, date_format=None):
331
"""Intercept log and trace messages and send them to a file.
333
:param to_file: A file-like object to which messages will be sent.
335
:returns: A memento that should be passed to _pop_log_file to restore the
336
previously active logging.
340
new_handler = logging.StreamHandler(to_file)
341
new_handler.setLevel(logging.DEBUG)
342
if log_format is None:
343
log_format = '%(levelname)8s %(message)s'
344
new_handler.setFormatter(logging.Formatter(log_format, date_format))
345
# save and remove any existing log handlers
346
bzr_logger = logging.getLogger('bzr')
347
old_handlers = bzr_logger.handlers[:]
348
del bzr_logger.handlers[:]
349
# set that as the default logger
350
bzr_logger.addHandler(new_handler)
351
bzr_logger.setLevel(logging.DEBUG)
352
# TODO: check if any changes are needed to the root logger
354
# TODO: also probably need to save and restore the level on bzr_logger.
355
# but maybe we can avoid setting the logger level altogether, and just set
356
# the level on the handler?
358
# save the old trace file
359
old_trace_file = _trace_file
360
# send traces to the new one
361
_trace_file = to_file
362
result = new_handler, _trace_file
363
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
366
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
367
"""Undo changes to logging/tracing done by _push_log_file.
369
This flushes, but does not close the trace file.
371
Takes the memento returned from _push_log_file."""
373
_trace_file = old_trace_file
374
bzr_logger = logging.getLogger('bzr')
375
bzr_logger.removeHandler(new_handler)
376
# must be closed, otherwise logging will try to close it atexit, and the
377
# file will likely already be closed underneath.
379
bzr_logger.handlers = old_handlers
380
new_trace_file.flush()
153
#tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
154
tf = open(trace_fname, 'at', LINE_BUFFERED)
157
tf.write("\nthis is a debug log for diagnosing/reporting problems in bzr\n")
158
tf.write("you can delete or truncate this file, or include sections in\n")
159
tf.write("bug reports to bazaar-ng@lists.canonical.com\n\n")
160
_file_handler = logging.StreamHandler(tf)
161
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
162
datefmt = r'%a %H:%M:%S'
163
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
164
_file_handler.setLevel(logging.DEBUG)
165
logging.getLogger('').addHandler(_file_handler)
167
warning("failed to open trace file: %s" % (e))
170
@deprecated_function(zero_nine)
171
def log_exception(msg=None):
172
"""Log the last exception to stderr and the trace file.
174
The exception string representation is used as the error
175
summary, unless msg is given.
179
log_exception_quietly()
383
182
def log_exception_quietly():
384
183
"""Log the last exception to the trace file only.
386
Used for exceptions that occur internally and that may be
387
interesting to developers but not to users. For example,
185
Used for exceptions that occur internally and that may be
186
interesting to developers but not to users. For example,
388
187
errors loading plugins.
390
190
mutter(traceback.format_exc())
393
def set_verbosity_level(level):
394
"""Set the verbosity level.
396
:param level: -ve for quiet, 0 for normal, +ve for verbose
398
global _verbosity_level
399
_verbosity_level = level
400
_update_logging_level(level < 0)
401
ui.ui_factory.be_quiet(level < 0)
404
def get_verbosity_level():
405
"""Get the verbosity level.
407
See set_verbosity_level() for values.
409
return _verbosity_level
193
def enable_default_logging():
194
"""Configure default logging to stderr and .bzr.log"""
195
# FIXME: if this is run twice, things get confused
196
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
197
_stderr_handler = logging.StreamHandler()
198
logging.getLogger('').addHandler(_stderr_handler)
199
_stderr_handler.setLevel(logging.INFO)
200
if not _file_handler:
202
_trace_file = _bzr_log_file
204
_file_handler.setLevel(logging.DEBUG)
205
_bzr_logger.setLevel(logging.DEBUG)
412
208
def be_quiet(quiet=True):
414
set_verbosity_level(-1)
416
set_verbosity_level(0)
419
def _update_logging_level(quiet=True):
420
"""Hide INFO messages if quiet."""
422
_bzr_logger.setLevel(logging.WARNING)
424
_bzr_logger.setLevel(logging.INFO)
209
global _stderr_handler, _stderr_quiet
211
_stderr_quiet = quiet
213
_stderr_handler.setLevel(logging.WARNING)
215
_stderr_handler.setLevel(logging.INFO)
428
"""Is the verbosity level negative?"""
429
return _verbosity_level < 0
433
"""Is the verbosity level positive?"""
434
return _verbosity_level > 0
437
def debug_memory(message='', short=True):
438
"""Write out a memory dump."""
439
if sys.platform == 'win32':
440
from bzrlib import win32utils
441
win32utils.debug_memory_win32api(message=message, short=short)
443
_debug_memory_proc(message=message, short=short)
446
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
448
def _debug_memory_proc(message='', short=True):
450
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
454
status = status_file.read()
459
for line in status.splitlines():
463
for field in _short_fields:
464
if line.startswith(field):
223
def disable_default_logging():
224
"""Turn off default log handlers.
226
This is intended to be used by the test framework, which doesn't
227
want leakage from the code-under-test into the main logs.
230
l = logging.getLogger('')
231
l.removeHandler(_stderr_handler)
233
l.removeHandler(_file_handler)
237
def enable_test_log(to_file):
238
"""Redirect logging to a temporary file for a test
240
returns an opaque reference that should be passed to disable_test_log
241
after the test completes.
243
disable_default_logging()
246
hdlr = logging.StreamHandler(to_file)
247
hdlr.setLevel(logging.DEBUG)
248
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
249
_bzr_logger.addHandler(hdlr)
250
_bzr_logger.setLevel(logging.DEBUG)
251
result = hdlr, _trace_file, _trace_depth
252
_trace_file = to_file
257
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
258
_bzr_logger.removeHandler(test_log_hdlr)
259
test_log_hdlr.close()
262
_trace_file = old_trace_file
263
_trace_depth = old_trace_depth
265
enable_default_logging()
469
268
def report_exception(exc_info, err_file):
470
"""Report an exception to err_file (typically stderr) and to .bzr.log.
472
This will show either a full traceback or a short message as appropriate.
474
:return: The appropriate exit code for this error.
269
exc_type, exc_object, exc_tb = exc_info
476
270
# Log the full traceback to ~/.bzr.log
477
271
log_exception_quietly()
478
if 'error' in debug.debug_flags:
479
print_exception(exc_info, err_file)
480
return errors.EXIT_ERROR
481
exc_type, exc_object, exc_tb = exc_info
482
272
if (isinstance(exc_object, IOError)
483
273
and getattr(exc_object, 'errno', None) == errno.EPIPE):
484
err_file.write("bzr: broken pipe\n")
485
return errors.EXIT_ERROR
274
print >>err_file, "bzr: broken pipe"
486
275
elif isinstance(exc_object, KeyboardInterrupt):
487
err_file.write("bzr: interrupted\n")
488
return errors.EXIT_ERROR
489
elif isinstance(exc_object, MemoryError):
490
err_file.write("bzr: out of memory\n")
491
return errors.EXIT_ERROR
492
elif isinstance(exc_object, ImportError) \
493
and str(exc_object).startswith("No module named "):
494
report_user_error(exc_info, err_file,
495
'You may need to install this Python library separately.')
496
return errors.EXIT_ERROR
276
print >>err_file, "bzr: interrupted"
497
277
elif not getattr(exc_object, 'internal_error', True):
498
278
report_user_error(exc_info, err_file)
499
return errors.EXIT_ERROR
500
279
elif isinstance(exc_object, (OSError, IOError)):
501
280
# Might be nice to catch all of these and show them as something more
502
281
# specific, but there are too many cases at the moment.
503
282
report_user_error(exc_info, err_file)
504
return errors.EXIT_ERROR
506
report_bug(exc_info, err_file)
507
return errors.EXIT_INTERNAL_ERROR
510
def print_exception(exc_info, err_file):
511
exc_type, exc_object, exc_tb = exc_info
512
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
513
exc_type.__module__, exc_type.__name__, exc_object))
515
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
284
return report_bug(exc_info, err_file)
518
287
# TODO: Should these be specially encoding the output?
519
def report_user_error(exc_info, err_file, advice=None):
288
def report_user_error(exc_info, err_file):
520
289
"""Report to err_file an error that's not an internal error.
522
291
These don't get a traceback unless -Derror was given.
524
:param exc_info: 3-tuple from sys.exc_info()
525
:param advice: Extra advice to the user to be printed following the
528
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
530
err_file.write("%s\n" % (advice,))
293
if 'error' in debug.debug_flags:
294
report_bug(exc_info, err_file)
296
print >>err_file, "bzr: ERROR:", str(exc_info[1])
533
299
def report_bug(exc_info, err_file):
534
300
"""Report an exception that probably indicates a bug in bzr"""
535
from bzrlib.crash import report_bug
536
report_bug(exc_info, err_file)
539
def _flush_stdout_stderr():
540
# installed into an atexit hook by bzrlib.initialize()
546
if e.errno in [errno.EINVAL, errno.EPIPE]:
553
# run from atexit hook
301
# local import because its only needed here, and this is not a loop.
303
# local import because the other functions do it too.
305
# local import due to circular dependency
309
# detect apport presence.
311
import problem_report
313
# not present, dont use it.
316
# policy disabled, or not present, use the old ui.
317
return _old_report_bug(exc_info, err_file)
319
exc_type, exc_object, exc_tb = exc_info
321
"bzr: ERROR: %s.%s: %s\n" % (
322
exc_type.__module__, exc_type.__name__, exc_object)
324
report = problem_report.ProblemReport()
325
report_file, report_filename = tempfile.mkstemp(
326
suffix='.txt', prefix='bzr-crash-', dir='/tmp')
327
python_report_file = os.fdopen(report_file, 'w')
329
report['CommandLine'] = ' '.join(sys.argv)
330
# assume we are packaged as bzr.
331
apport_utils.report_add_package_info(report, 'bzr')
332
report['BzrPlugins'] = ' '.join(bzrlib.plugin.all_plugins())
334
traceback.print_exception(exc_type, exc_object, exc_tb, file=tb_file)
335
report['Traceback'] = tb_file.getvalue()
336
apport_utils.report_add_os_info(report)
337
report.write(python_report_file)
338
# give the user a pretty output.
341
'This is an unexpected error within bzr and we would appreciate a bug report.\n'
343
'bzr has written a crash report file that will assist our debugging of this\n'
346
'This is a plain text file, whose contents you can check if you have privacy\n'
347
'concerns. We gather the package data about bzr, your command line, plugins\n'
348
'And the backtrace from within bzr. If you had a password in the URL you\n'
349
'provided to bzr, you should edit that file to remove the password.\n'
351
'** To file a bug for this please visit our bugtracker at the URL \n'
352
'"https://launchpad.net/products/bzr/+filebug" and report a bug describing\n'
353
'what you were attempting and attach the bzr-crash file mentioned above.\n'
354
'Alternatively you can email bazaar-ng@lists.canonical.com with the same\n'
355
'description and attach the bzr-crash file to the email.\n' %
359
python_report_file.close()
360
return report, report_filename
362
def _old_report_bug(exc_info, err_file):
363
"""Write a synopsis of an exception that is probably a bug to err_file."""
365
exc_type, exc_object, exc_tb = exc_info
366
print >>err_file, "bzr: ERROR: %s.%s: %s" % (
367
exc_type.__module__, exc_type.__name__, exc_object)
369
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
371
print >>err_file, 'bzr %s on python %s (%s)' % \
373
'.'.join(map(str, sys.version_info)),
375
print >>err_file, 'arguments: %r' % sys.argv
377
print >>err_file, "** please send this report to bazaar-ng@lists.ubuntu.com"
added
removed
bzrlib/trace.py
