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
57
63
from bzrlib.lazy_import import lazy_import
58
64
lazy_import(globals(), """
59
65
from cStringIO import StringIO
73
from bzrlib.symbol_versioning import (
68
78
lazy_import(globals(), """
69
79
from bzrlib import (
78
_stderr_handler = None
90
# global verbosity for bzrlib; controls the log level for stderr; 0=normal; <0
91
# is quiet; >0 is verbose.
79
92
_verbosity_level = 0
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.
83
102
_bzr_log_filename = None
86
# configure convenient aliases for output routines
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
88
110
_bzr_logger = logging.getLogger('bzr')
90
113
def note(*args, **kwargs):
91
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.
93
120
bzrlib.ui.ui_factory.clear_term()
94
121
_bzr_logger.info(*args, **kwargs)
96
124
def warning(*args, **kwargs):
98
126
bzrlib.ui.ui_factory.clear_term()
99
127
_bzr_logger.warning(*args, **kwargs)
102
log_error = _bzr_logger.error
103
error = _bzr_logger.error
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)
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)
106
156
def mutter(fmt, *args):
107
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.
109
161
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
160
def open_tracefile(tracefilename=None):
161
# Messages are always written to here, so that we have some
162
# information if something goes wrong. In a future version this
163
# file will be removed on successful completion.
164
global _file_handler, _bzr_log_file, _bzr_log_filename
167
if tracefilename is None:
217
def _get_bzr_log_filename():
218
bzr_log = os.environ.get('BZR_LOG')
221
home = os.environ.get('BZR_HOME')
168
223
if sys.platform == 'win32':
169
224
from bzrlib import win32utils
170
225
home = win32utils.get_home_location()
172
227
home = os.path.expanduser('~')
173
_bzr_log_filename = os.path.join(home, '.bzr.log')
175
_bzr_log_filename = tracefilename
177
_bzr_log_filename = os.path.expanduser(_bzr_log_filename)
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
241
_bzr_log_filename = _get_bzr_log_filename()
178
242
_rollover_trace_maybe(_bzr_log_filename)
181
#tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
182
tf = open(_bzr_log_filename, 'at', LINE_BUFFERED)
184
# tf.tell() on windows always return 0 until some writing done
187
tf.write("this is a debug log for diagnosing/reporting problems in bzr\n")
188
tf.write("you can delete or truncate this file, or include sections in\n")
189
tf.write("bug reports to bazaar@lists.canonical.com\n\n")
190
_file_handler = logging.StreamHandler(tf)
191
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
192
datefmt = r'%a %H:%M:%S'
193
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
194
_file_handler.setLevel(logging.DEBUG)
195
logging.getLogger('').addHandler(_file_handler)
244
bzr_log_file = open(_bzr_log_filename, 'at', buffering=0) # unbuffered
245
# bzr_log_file.tell() on windows always return 0 until some writing done
246
bzr_log_file.write('\n')
247
if bzr_log_file.tell() <= 2:
248
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
249
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
250
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
196
252
except IOError, e:
197
warning("failed to open trace file: %s" % (e))
253
# If we are failing to open the log, then most likely logging has not
254
# been set up yet. So we just write to stderr rather than using
255
# 'warning()'. If we using warning(), users get the unhelpful 'no
256
# handlers registered for "bzr"' when something goes wrong on the
257
# server. (bug #503886)
258
sys.stderr.write("failed to open trace file: %s\n" % (e,))
259
# TODO: What should happen if we fail to open the trace file? Maybe the
260
# objects should be pointed at /dev/null or the equivalent? Currently
261
# returns None which will cause failures later.
265
def enable_default_logging():
266
"""Configure default logging: messages to stderr and debug to .bzr.log
268
This should only be called once per process.
270
Non-command-line programs embedding bzrlib do not need to call this. They
271
can instead either pass a file to _push_log_file, or act directly on
272
logging.getLogger("bzr").
274
Output can be redirected away by calling _push_log_file.
276
# Do this before we open the log file, so we prevent
277
# get_terminal_encoding() from mutter()ing multiple times
278
term_encoding = osutils.get_terminal_encoding()
279
start_time = osutils.format_local_date(_bzr_log_start_time,
281
# create encoded wrapper around stderr
282
bzr_log_file = _open_bzr_log()
283
if bzr_log_file is not None:
284
bzr_log_file.write(start_time.encode('utf-8') + '\n')
285
push_log_file(bzr_log_file,
286
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
287
r'%Y-%m-%d %H:%M:%S')
288
# after hooking output into bzr_log, we also need to attach a stderr
289
# handler, writing only at level info and with encoding
290
writer_factory = codecs.getwriter(term_encoding)
291
encoded_stderr = writer_factory(sys.stderr, errors='replace')
292
stderr_handler = logging.StreamHandler(encoded_stderr)
293
stderr_handler.setLevel(logging.INFO)
294
logging.getLogger('bzr').addHandler(stderr_handler)
297
def push_log_file(to_file, log_format=None, date_format=None):
298
"""Intercept log and trace messages and send them to a file.
300
:param to_file: A file-like object to which messages will be sent.
302
:returns: A memento that should be passed to _pop_log_file to restore the
303
previously active logging.
307
new_handler = logging.StreamHandler(to_file)
308
new_handler.setLevel(logging.DEBUG)
309
if log_format is None:
310
log_format = '%(levelname)8s %(message)s'
311
new_handler.setFormatter(logging.Formatter(log_format, date_format))
312
# save and remove any existing log handlers
313
bzr_logger = logging.getLogger('bzr')
314
old_handlers = bzr_logger.handlers[:]
315
del bzr_logger.handlers[:]
316
# set that as the default logger
317
bzr_logger.addHandler(new_handler)
318
bzr_logger.setLevel(logging.DEBUG)
319
# TODO: check if any changes are needed to the root logger
321
# TODO: also probably need to save and restore the level on bzr_logger.
322
# but maybe we can avoid setting the logger level altogether, and just set
323
# the level on the handler?
325
# save the old trace file
326
old_trace_file = _trace_file
327
# send traces to the new one
328
_trace_file = to_file
329
result = new_handler, _trace_file
330
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
333
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
334
"""Undo changes to logging/tracing done by _push_log_file.
336
This flushes, but does not close the trace file.
338
Takes the memento returned from _push_log_file."""
340
_trace_file = old_trace_file
341
bzr_logger = logging.getLogger('bzr')
342
bzr_logger.removeHandler(new_handler)
343
# must be closed, otherwise logging will try to close it atexit, and the
344
# file will likely already be closed underneath.
346
bzr_logger.handlers = old_handlers
347
new_trace_file.flush()
200
350
def log_exception_quietly():
201
351
"""Log the last exception to the trace file only.
203
Used for exceptions that occur internally and that may be
204
interesting to developers but not to users. For example,
353
Used for exceptions that occur internally and that may be
354
interesting to developers but not to users. For example,
205
355
errors loading plugins.
208
357
mutter(traceback.format_exc())
211
def enable_default_logging():
212
"""Configure default logging to stderr and .bzr.log"""
213
# FIXME: if this is run twice, things get confused
214
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
215
_stderr_handler = logging.StreamHandler()
216
logging.getLogger('').addHandler(_stderr_handler)
217
_stderr_handler.setLevel(logging.INFO)
218
if not _file_handler:
220
_trace_file = _bzr_log_file
222
_file_handler.setLevel(logging.DEBUG)
223
_bzr_logger.setLevel(logging.DEBUG)
226
360
def set_verbosity_level(level):
227
361
"""Set the verbosity level.
267
401
return _verbosity_level > 0
270
def disable_default_logging():
271
"""Turn off default log handlers.
273
This is intended to be used by the test framework, which doesn't
274
want leakage from the code-under-test into the main logs.
277
l = logging.getLogger('')
278
l.removeHandler(_stderr_handler)
280
l.removeHandler(_file_handler)
284
def enable_test_log(to_file):
285
"""Redirect logging to a temporary file for a test
287
returns an opaque reference that should be passed to disable_test_log
288
after the test completes.
290
disable_default_logging()
293
hdlr = logging.StreamHandler(to_file)
294
hdlr.setLevel(logging.DEBUG)
295
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
296
_bzr_logger.addHandler(hdlr)
297
_bzr_logger.setLevel(logging.DEBUG)
298
result = hdlr, _trace_file, _trace_depth
299
_trace_file = to_file
304
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
305
_bzr_logger.removeHandler(test_log_hdlr)
306
test_log_hdlr.close()
309
_trace_file = old_trace_file
310
_trace_depth = old_trace_depth
312
enable_default_logging()
404
def debug_memory(message='', short=True):
405
"""Write out a memory dump."""
406
if sys.platform == 'win32':
407
from bzrlib import win32utils
408
win32utils.debug_memory_win32api(message=message, short=short)
410
_debug_memory_proc(message=message, short=short)
413
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
415
def _debug_memory_proc(message='', short=True):
417
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
421
status = status_file.read()
426
for line in status.splitlines():
430
for field in _short_fields:
431
if line.startswith(field):
315
436
def report_exception(exc_info, err_file):
342
474
return errors.EXIT_INTERNAL_ERROR
477
def print_exception(exc_info, err_file):
478
exc_type, exc_object, exc_tb = exc_info
479
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
480
exc_type.__module__, exc_type.__name__, exc_object))
482
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
345
485
# TODO: Should these be specially encoding the output?
346
def report_user_error(exc_info, err_file):
486
def report_user_error(exc_info, err_file, advice=None):
347
487
"""Report to err_file an error that's not an internal error.
349
489
These don't get a traceback unless -Derror was given.
491
:param exc_info: 3-tuple from sys.exc_info()
492
:param advice: Extra advice to the user to be printed following the
351
if 'error' in debug.debug_flags:
352
report_bug(exc_info, err_file)
354
495
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
497
err_file.write("%s\n" % (advice,))
357
500
def report_bug(exc_info, err_file):
358
501
"""Report an exception that probably indicates a bug in bzr"""
360
exc_type, exc_object, exc_tb = exc_info
361
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
362
exc_type.__module__, exc_type.__name__, exc_object))
364
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
366
err_file.write('bzr %s on python %s (%s)\n' % \
368
'.'.join(map(str, sys.version_info)),
370
err_file.write('arguments: %r\n' % sys.argv)
372
'encoding: %r, fsenc: %r, lang: %r\n' % (
373
osutils.get_user_encoding(), sys.getfilesystemencoding(),
374
os.environ.get('LANG')))
375
err_file.write("plugins:\n")
376
for name, a_plugin in sorted(plugin.plugins().items()):
377
err_file.write(" %-20s %s [%s]\n" %
378
(name, a_plugin.path(), a_plugin.__version__))
381
"** Please send this report to bazaar@lists.ubuntu.com\n"
382
" with a description of what you were doing when the\n"
502
from bzrlib.crash import report_bug
503
report_bug(exc_info, err_file)
506
def _flush_stdout_stderr():
507
# installed into an atexit hook by bzrlib.initialize()
513
if e.errno in [errno.EINVAL, errno.EPIPE]:
520
# run from atexit hook