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
59
from bzrlib.lazy_import import lazy_import
64
60
lazy_import(globals(), """
65
61
from cStringIO import StringIO
74
from bzrlib.symbol_versioning import (
79
69
lazy_import(globals(), """
80
70
from bzrlib import (
89
# global verbosity for bzrlib; controls the log level for stderr; 0=normal; <0
90
# is quiet; >0 is verbose.
79
_stderr_handler = None
91
80
_verbosity_level = 0
93
# File-like object where mutter/debug output is currently sent. Can be
94
# changed by _push_log_file etc. This is directly manipulated by some
95
# external code; maybe there should be functions to do that more precisely
96
# than push/pop_log_file.
99
# Absolute path for ~/.bzr.log. Not changed even if the log/trace output is
100
# redirected elsewhere. Used to show the location in --version.
101
84
_bzr_log_filename = None
103
# The time the first message was written to the trace file, so that we can
104
# show relative times since startup.
105
_bzr_log_start_time = bzrlib._start_time
108
# held in a global for quick reference
87
# configure convenient aliases for output routines
109
89
_bzr_logger = logging.getLogger('bzr')
112
92
def note(*args, **kwargs):
113
"""Output a note to the user.
115
Takes the same parameters as logging.info.
119
93
# 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.
124
ui.ui_factory.clear_term()
95
bzrlib.ui.ui_factory.clear_term()
125
96
_bzr_logger.info(*args, **kwargs)
128
98
def warning(*args, **kwargs):
129
ui.ui_factory.clear_term()
100
bzrlib.ui.ui_factory.clear_term()
130
101
_bzr_logger.warning(*args, **kwargs)
133
@deprecated_function(deprecated_in((2, 1, 0)))
134
def info(*args, **kwargs):
135
"""Deprecated: use trace.note instead."""
136
note(*args, **kwargs)
139
@deprecated_function(deprecated_in((2, 1, 0)))
140
def log_error(*args, **kwargs):
141
"""Deprecated: use bzrlib.trace.show_error instead"""
142
_bzr_logger.error(*args, **kwargs)
145
@deprecated_function(deprecated_in((2, 1, 0)))
146
def error(*args, **kwargs):
147
"""Deprecated: use bzrlib.trace.show_error instead"""
148
_bzr_logger.error(*args, **kwargs)
151
def show_error(*args, **kwargs):
152
"""Show an error message to the user.
154
Don't use this for exceptions, use report_exception instead.
156
_bzr_logger.error(*args, **kwargs)
104
log_error = _bzr_logger.error
105
error = _bzr_logger.error
159
108
def mutter(fmt, *args):
160
109
if _trace_file is None:
162
# XXX: Don't check this every time; instead anyone who closes the file
163
# ought to deregister it. We can tolerate None.
164
111
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
220
def _get_bzr_log_filename():
221
bzr_log = os.environ.get('BZR_LOG')
224
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:
226
170
if sys.platform == 'win32':
227
171
from bzrlib import win32utils
228
172
home = win32utils.get_home_location()
230
174
home = os.path.expanduser('~')
231
return os.path.join(home, '.bzr.log')
235
"""Open the .bzr.log trace file.
237
If the log is more than a particular length, the old file is renamed to
238
.bzr.log.old and a new file is started. Otherwise, we append to the
241
This sets the global _bzr_log_filename.
243
global _bzr_log_filename
245
def _open_or_create_log_file(filename):
246
"""Open existing log file, or create with ownership and permissions
248
It inherits the ownership and permissions (masked by umask) from
249
the containing directory to cope better with being run under sudo
250
with $HOME still set to the user's homedir.
252
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
255
fd = os.open(filename, flags)
258
if e.errno != errno.ENOENT:
261
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
263
if e.errno != errno.EEXIST:
266
osutils.copy_ownership_from_path(filename)
268
return os.fdopen(fd, 'at', 0) # unbuffered
271
_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)
272
180
_rollover_trace_maybe(_bzr_log_filename)
274
bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
275
bzr_log_file.write('\n')
276
if bzr_log_file.tell() <= 2:
277
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
278
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
279
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
283
except EnvironmentError, e:
284
# If we are failing to open the log, then most likely logging has not
285
# been set up yet. So we just write to stderr rather than using
286
# 'warning()'. If we using warning(), users get the unhelpful 'no
287
# handlers registered for "bzr"' when something goes wrong on the
288
# server. (bug #503886)
289
sys.stderr.write("failed to open trace file: %s\n" % (e,))
290
# TODO: What should happen if we fail to open the trace file? Maybe the
291
# objects should be pointed at /dev/null or the equivalent? Currently
292
# returns None which will cause failures later.
296
def enable_default_logging():
297
"""Configure default logging: messages to stderr and debug to .bzr.log
299
This should only be called once per process.
301
Non-command-line programs embedding bzrlib do not need to call this. They
302
can instead either pass a file to _push_log_file, or act directly on
303
logging.getLogger("bzr").
305
Output can be redirected away by calling _push_log_file.
307
:return: A memento from push_log_file for restoring the log state.
309
start_time = osutils.format_local_date(_bzr_log_start_time,
311
# create encoded wrapper around stderr
312
bzr_log_file = _open_bzr_log()
313
if bzr_log_file is not None:
314
bzr_log_file.write(start_time.encode('utf-8') + '\n')
315
memento = push_log_file(bzr_log_file,
316
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
317
r'%Y-%m-%d %H:%M:%S')
318
# after hooking output into bzr_log, we also need to attach a stderr
319
# handler, writing only at level info and with encoding
320
term_encoding = osutils.get_terminal_encoding()
321
writer_factory = codecs.getwriter(term_encoding)
322
encoded_stderr = writer_factory(sys.stderr, errors='replace')
323
stderr_handler = logging.StreamHandler(encoded_stderr)
324
stderr_handler.setLevel(logging.INFO)
325
logging.getLogger('bzr').addHandler(stderr_handler)
329
def push_log_file(to_file, log_format=None, date_format=None):
330
"""Intercept log and trace messages and send them to a file.
332
:param to_file: A file-like object to which messages will be sent.
334
:returns: A memento that should be passed to _pop_log_file to restore the
335
previously active logging.
339
new_handler = logging.StreamHandler(to_file)
340
new_handler.setLevel(logging.DEBUG)
341
if log_format is None:
342
log_format = '%(levelname)8s %(message)s'
343
new_handler.setFormatter(logging.Formatter(log_format, date_format))
344
# save and remove any existing log handlers
345
bzr_logger = logging.getLogger('bzr')
346
old_handlers = bzr_logger.handlers[:]
347
del bzr_logger.handlers[:]
348
# set that as the default logger
349
bzr_logger.addHandler(new_handler)
350
bzr_logger.setLevel(logging.DEBUG)
351
# TODO: check if any changes are needed to the root logger
353
# TODO: also probably need to save and restore the level on bzr_logger.
354
# but maybe we can avoid setting the logger level altogether, and just set
355
# the level on the handler?
357
# save the old trace file
358
old_trace_file = _trace_file
359
# send traces to the new one
360
_trace_file = to_file
361
result = new_handler, _trace_file
362
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
365
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
366
"""Undo changes to logging/tracing done by _push_log_file.
368
This flushes, but does not close the trace file (so that anything that was
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 at exit, and the
377
# file will likely already be closed underneath.
379
bzr_logger.handlers = old_handlers
380
if new_trace_file is not None:
381
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 https://bugs.launchpad.net/bzr/+filebug\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))
384
202
def log_exception_quietly():
385
203
"""Log the last exception to the trace file only.
387
Used for exceptions that occur internally and that may be
388
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,
389
207
errors loading plugins.
391
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)
394
231
def set_verbosity_level(level):
395
232
"""Set the verbosity level.
435
272
return _verbosity_level > 0
438
def debug_memory(message='', short=True):
439
"""Write out a memory dump."""
440
if sys.platform == 'win32':
441
from bzrlib import win32utils
442
win32utils.debug_memory_win32api(message=message, short=short)
444
_debug_memory_proc(message=message, short=short)
447
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
449
def _debug_memory_proc(message='', short=True):
451
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
455
status = status_file.read()
460
for line in status.splitlines():
464
for field in _short_fields:
465
if line.startswith(field):
469
def _dump_memory_usage(err_file):
472
fd, name = tempfile.mkstemp(prefix="bzr_memdump", suffix=".json")
473
dump_file = os.fdopen(fd, 'w')
474
from meliae import scanner
475
scanner.dump_gc_objects(dump_file)
476
err_file.write("Memory dumped to %s\n" % name)
478
err_file.write("Dumping memory requires meliae module.\n")
479
log_exception_quietly()
481
err_file.write("Exception while dumping memory.\n")
482
log_exception_quietly()
484
if dump_file is not None:
490
def _qualified_exception_name(eclass, unqualified_bzrlib_errors=False):
491
"""Give name of error class including module for non-builtin exceptions
493
If `unqualified_bzrlib_errors` is True, errors specific to bzrlib will
494
also omit the module prefix.
496
class_name = eclass.__name__
497
module_name = eclass.__module__
498
if module_name in ("exceptions", "__main__") or (
499
unqualified_bzrlib_errors and module_name == "bzrlib.errors"):
501
return "%s.%s" % (module_name, class_name)
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()
504
320
def report_exception(exc_info, err_file):
548
347
return errors.EXIT_INTERNAL_ERROR
551
def print_exception(exc_info, err_file):
552
exc_type, exc_object, exc_tb = exc_info
553
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
554
exc_type.__module__, exc_type.__name__, exc_object))
556
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
559
350
# TODO: Should these be specially encoding the output?
560
def report_user_error(exc_info, err_file, advice=None):
351
def report_user_error(exc_info, err_file):
561
352
"""Report to err_file an error that's not an internal error.
563
354
These don't get a traceback unless -Derror was given.
565
:param exc_info: 3-tuple from sys.exc_info()
566
: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)
569
359
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
571
err_file.write("%s\n" % (advice,))
574
362
def report_bug(exc_info, err_file):
575
363
"""Report an exception that probably indicates a bug in bzr"""
576
from bzrlib.crash import report_bug
577
report_bug(exc_info, err_file)
580
def _flush_stdout_stderr():
581
# called from the bzrlib library finalizer returned by bzrlib.initialize()
587
if e.errno in [errno.EINVAL, errno.EPIPE]:
594
# called from the bzrlib library finalizer returned by bzrlib.initialize()
600
class Config(object):
601
"""Configuration of message tracing in bzrlib.
603
This implements the context manager protocol and should manage any global
604
variables still used. The default config used is DefaultConfig, but
605
embedded uses of bzrlib may wish to use a custom manager.
609
return self # This is bound to the 'as' clause in a with statement.
611
def __exit__(self, exc_type, exc_val, exc_tb):
612
return False # propogate exceptions.
615
class DefaultConfig(Config):
616
"""A default configuration for tracing of messages in bzrlib.
618
This implements the context manager protocol.
622
self._original_filename = _bzr_log_filename
623
self._original_state = enable_default_logging()
624
return self # This is bound to the 'as' clause in a with statement.
626
def __exit__(self, exc_type, exc_val, exc_tb):
627
pop_log_file(self._original_state)
628
global _bzr_log_filename
629
_bzr_log_filename = self._original_filename
630
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
*** Bazaar has encountered an internal error.
387
Please report a bug at https://bugs.launchpad.net/bzr/+filebug
388
including this traceback, and a description of what you
389
were doing when the error occurred.
added
removed
bzrlib/trace.py
