73
from bzrlib.symbol_versioning import (
78
69
lazy_import(globals(), """
79
70
from bzrlib import (
90
# global verbosity for bzrlib; controls the log level for stderr; 0=normal; <0
91
# is quiet; >0 is verbose.
79
_stderr_handler = None
92
80
_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.
102
84
_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
87
# configure convenient aliases for output routines
110
89
_bzr_logger = logging.getLogger('bzr')
113
92
def note(*args, **kwargs):
114
"""Output a note to the user.
116
Takes the same parameters as logging.info.
120
93
# 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
95
bzrlib.ui.ui_factory.clear_term()
127
96
_bzr_logger.info(*args, **kwargs)
130
98
def warning(*args, **kwargs):
132
100
bzrlib.ui.ui_factory.clear_term()
133
101
_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)
104
log_error = _bzr_logger.error
105
error = _bzr_logger.error
162
108
def mutter(fmt, *args):
163
109
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
111
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
223
def _get_bzr_log_filename():
224
bzr_log = os.environ.get('BZR_LOG')
227
home = os.environ.get('BZR_HOME')
162
def open_tracefile(tracefilename=None):
163
# Messages are always written to here, so that we have some
164
# information if something goes wrong. In a future version this
165
# file will be removed on successful completion.
166
global _file_handler, _bzr_log_file, _bzr_log_filename
169
if tracefilename is None:
229
170
if sys.platform == 'win32':
230
171
from bzrlib import win32utils
231
172
home = win32utils.get_home_location()
233
174
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()
175
_bzr_log_filename = os.path.join(home, '.bzr.log')
177
_bzr_log_filename = tracefilename
179
_bzr_log_filename = os.path.expanduser(_bzr_log_filename)
275
180
_rollover_trace_maybe(_bzr_log_filename)
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()
183
#tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
184
tf = open(_bzr_log_filename, 'at', LINE_BUFFERED)
186
# tf.tell() on windows always return 0 until some writing done
189
tf.write("this is a debug log for diagnosing/reporting problems in bzr\n")
190
tf.write("you can delete or truncate this file, or include sections in\n")
191
tf.write("bug reports to bazaar@lists.canonical.com\n\n")
192
_file_handler = logging.StreamHandler(tf)
193
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
194
datefmt = r'%a %H:%M:%S'
195
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
196
_file_handler.setLevel(logging.DEBUG)
197
logging.getLogger('').addHandler(_file_handler)
199
warning("failed to open trace file: %s" % (e))
387
202
def log_exception_quietly():
388
203
"""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,
205
Used for exceptions that occur internally and that may be
206
interesting to developers but not to users. For example,
392
207
errors loading plugins.
394
210
mutter(traceback.format_exc())
213
def enable_default_logging():
214
"""Configure default logging to stderr and .bzr.log"""
215
# FIXME: if this is run twice, things get confused
216
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
217
# create encoded wrapper around stderr
218
stderr = codecs.getwriter(osutils.get_terminal_encoding())(sys.stderr,
220
_stderr_handler = logging.StreamHandler(stderr)
221
logging.getLogger('').addHandler(_stderr_handler)
222
_stderr_handler.setLevel(logging.INFO)
223
if not _file_handler:
225
_trace_file = _bzr_log_file
227
_file_handler.setLevel(logging.DEBUG)
228
_bzr_logger.setLevel(logging.DEBUG)
397
231
def set_verbosity_level(level):
398
232
"""Set the verbosity level.
438
272
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):
275
def disable_default_logging():
276
"""Turn off default log handlers.
278
This is intended to be used by the test framework, which doesn't
279
want leakage from the code-under-test into the main logs.
282
l = logging.getLogger('')
283
l.removeHandler(_stderr_handler)
285
l.removeHandler(_file_handler)
289
def enable_test_log(to_file):
290
"""Redirect logging to a temporary file for a test
292
returns an opaque reference that should be passed to disable_test_log
293
after the test completes.
295
disable_default_logging()
298
hdlr = logging.StreamHandler(to_file)
299
hdlr.setLevel(logging.DEBUG)
300
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
301
_bzr_logger.addHandler(hdlr)
302
_bzr_logger.setLevel(logging.DEBUG)
303
result = hdlr, _trace_file, _trace_depth
304
_trace_file = to_file
309
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
310
_bzr_logger.removeHandler(test_log_hdlr)
311
test_log_hdlr.close()
314
_trace_file = old_trace_file
315
_trace_depth = old_trace_depth
317
enable_default_logging()
473
320
def report_exception(exc_info, err_file):
513
347
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
350
# TODO: Should these be specially encoding the output?
525
def report_user_error(exc_info, err_file, advice=None):
351
def report_user_error(exc_info, err_file):
526
352
"""Report to err_file an error that's not an internal error.
528
354
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
356
if 'error' in debug.debug_flags:
357
report_bug(exc_info, err_file)
534
359
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
536
err_file.write("%s\n" % (advice,))
539
362
def report_bug(exc_info, err_file):
540
363
"""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.
365
exc_type, exc_object, exc_tb = exc_info
366
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
367
exc_type.__module__, exc_type.__name__, exc_object))
369
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
371
err_file.write('bzr %s on python %s (%s)\n' % \
373
'.'.join(map(str, sys.version_info)),
375
err_file.write('arguments: %r\n' % sys.argv)
377
'encoding: %r, fsenc: %r, lang: %r\n' % (
378
osutils.get_user_encoding(), sys.getfilesystemencoding(),
379
os.environ.get('LANG')))
380
err_file.write("plugins:\n")
381
for name, a_plugin in sorted(plugin.plugins().items()):
382
err_file.write(" %-20s %s [%s]\n" %
383
(name, a_plugin.path(), a_plugin.__version__))
386
"** Please send this report to bazaar@lists.ubuntu.com\n"
387
" with a description of what you were doing when the\n"
added
removed
bzrlib/trace.py
