48
from __future__ import absolute_import
50
49
# FIXME: Unfortunately it turns out that python's logging module
51
50
# is quite expensive, even when the message is not printed by any handlers.
52
51
# We should perhaps change back to just simply doing it here.
54
# On the other hand, as of 1.2 we generally only call the mutter() statement
55
# if (according to debug_flags) we actually intend to write it. So the
56
# increased cost of logging.py is not so bad, and we could standardize on
57
from bzrlib.lazy_import import lazy_import
58
lazy_import(globals(), """
65
from .lazy_import import lazy_import
66
lazy_import(globals(), """
74
lazy_import(globals(), """
91
# global verbosity for breezy; 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.
64
from bzrlib.symbol_versioning import (deprecated_function,
68
lazy_import(globals(), """
69
from bzrlib import debug
73
_stderr_handler = None
101
# Absolute path for ~/.brz.log. Not changed even if the log/trace output is
102
# redirected elsewhere. Used to show the location in --version.
103
_brz_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
_brz_log_start_time = breezy._start_time
110
# held in a global for quick reference
111
_brz_logger = logging.getLogger('brz')
80
# configure convenient aliases for output routines
82
_bzr_logger = logging.getLogger('bzr')
114
84
def note(*args, **kwargs):
115
"""Output a note to the user.
117
Takes the same parameters as logging.info.
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()
125
_brz_logger.info(*args, **kwargs)
85
# FIXME note always emits utf-8, regardless of the terminal encoding
87
bzrlib.ui.ui_factory.clear_term()
88
_bzr_logger.info(*args, **kwargs)
128
90
def warning(*args, **kwargs):
129
ui.ui_factory.clear_term()
130
_brz_logger.warning(*args, **kwargs)
133
def show_error(*args, **kwargs):
134
"""Show an error message to the user.
136
Don't use this for exceptions, use report_exception instead.
138
_brz_logger.error(*args, **kwargs)
142
"""Compat class for displaying bytes on Python 2."""
145
return 'b' + str.__repr__(self)
147
def __unicode__(self):
148
return self.decode('ascii', 'replace')
92
bzrlib.ui.ui_factory.clear_term()
93
_bzr_logger.warning(*args, **kwargs)
96
log_error = _bzr_logger.error
97
error = _bzr_logger.error
151
100
def mutter(fmt, *args):
152
101
if _trace_file is None:
154
# XXX: Don't check this every time; instead anyone who closes the file
155
# ought to deregister it. We can tolerate None.
156
103
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
159
# Let format strings be specified as ascii bytes to help Python 2
160
if isinstance(fmt, bytes):
161
fmt = fmt.decode('ascii', 'replace')
106
if isinstance(fmt, unicode):
107
fmt = fmt.encode('utf8')
166
_Bytes(arg) if isinstance(arg, bytes) else arg for arg in args)
110
# It seems that if we do ascii % (unicode, ascii) we can
111
# get a unicode cannot encode ascii error, so make sure that "fmt"
112
# is a unicode string
115
if isinstance(arg, unicode):
116
arg = arg.encode('utf8')
117
real_args.append(arg)
118
out = fmt % tuple(real_args)
171
out = '%0.3f %s\n' % (now - _brz_log_start_time, out)
172
_trace_file.write(out.encode('utf-8'))
173
# there's no explicit flushing; the file is typically line buffered.
176
def mutter_callsite(stacklevel, fmt, *args):
177
"""Perform a mutter of fmt and args, logging the call trace.
179
:param stacklevel: The number of frames to show. None will show all
181
:param fmt: The format string to pass to mutter.
182
:param args: A list of substitution variables.
185
if stacklevel is None:
188
limit = stacklevel + 1
189
traceback.print_stack(limit=limit, file=outf)
190
formatted_lines = outf.getvalue().splitlines()
191
formatted_stack = '\n'.join(formatted_lines[:-2])
192
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
122
_trace_file.write(out)
123
# TODO: jam 20051227 Consider flushing the trace file to help debugging
195
127
def _rollover_trace_maybe(trace_fname):
199
131
if size <= 4 << 20:
201
133
old_fname = trace_fname + '.old'
202
osutils.rename(trace_fname, old_fname)
134
from osutils import rename
135
rename(trace_fname, old_fname)
207
def _get_brz_log_filename():
208
brz_log = osutils.path_from_environ('BRZ_LOG')
211
home = osutils.path_from_environ('BRZ_HOME')
213
# GZ 2012-02-01: Logging to the home dir is bad, but XDG is unclear
214
# over what would be better. On windows, bug 240550
215
# suggests LOCALAPPDATA be used instead.
216
home = osutils._get_home_dir()
217
return os.path.join(home, '.brz.log')
221
"""Open the .brz.log trace file.
223
If the log is more than a particular length, the old file is renamed to
224
.brz.log.old and a new file is started. Otherwise, we append to the
227
This sets the global _brz_log_filename.
229
global _brz_log_filename
231
def _open_or_create_log_file(filename):
232
"""Open existing log file, or create with ownership and permissions
234
It inherits the ownership and permissions (masked by umask) from
235
the containing directory to cope better with being run under sudo
236
with $HOME still set to the user's homedir.
238
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
241
fd = os.open(filename, flags)
244
if e.errno != errno.ENOENT:
247
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0o666)
249
if e.errno != errno.EEXIST:
252
osutils.copy_ownership_from_path(filename)
254
return os.fdopen(fd, 'ab', 0) # unbuffered
257
_brz_log_filename = _get_brz_log_filename()
258
_rollover_trace_maybe(_brz_log_filename)
140
def open_tracefile(tracefilename=None):
141
# Messages are always written to here, so that we have some
142
# information if something goes wrong. In a future version this
143
# file will be removed on successful completion.
144
global _file_handler, _bzr_log_file
147
if tracefilename is None:
148
if sys.platform == 'win32':
149
from bzrlib import win32utils
150
home = win32utils.get_home_location()
152
home = os.path.expanduser('~')
153
tracefilename = os.path.join(home, '.bzr.log')
155
trace_fname = os.path.expanduser(tracefilename)
156
_rollover_trace_maybe(trace_fname)
260
brz_log_file = _open_or_create_log_file(_brz_log_filename)
261
brz_log_file.write(b'\n')
262
if brz_log_file.tell() <= 2:
263
brz_log_file.write(b"this is a debug log for diagnosing/reporting problems in brz\n")
264
brz_log_file.write(b"you can delete or truncate this file, or include sections in\n")
265
brz_log_file.write(b"bug reports to https://bugs.launchpad.net/brz/+filebug\n\n")
269
except EnvironmentError as e:
270
# If we are failing to open the log, then most likely logging has not
271
# been set up yet. So we just write to stderr rather than using
272
# 'warning()'. If we using warning(), users get the unhelpful 'no
273
# handlers registered for "brz"' when something goes wrong on the
274
# server. (bug #503886)
275
sys.stderr.write("failed to open trace file: %s\n" % (e,))
276
# TODO: What should happen if we fail to open the trace file? Maybe the
277
# objects should be pointed at /dev/null or the equivalent? Currently
278
# returns None which will cause failures later.
282
def enable_default_logging():
283
"""Configure default logging: messages to stderr and debug to .brz.log
285
This should only be called once per process.
287
Non-command-line programs embedding breezy do not need to call this. They
288
can instead either pass a file to _push_log_file, or act directly on
289
logging.getLogger("brz").
291
Output can be redirected away by calling _push_log_file.
293
:return: A memento from push_log_file for restoring the log state.
295
start_time = osutils.format_local_date(_brz_log_start_time,
297
brz_log_file = _open_brz_log()
298
if brz_log_file is not None:
299
brz_log_file.write(start_time.encode('utf-8') + b'\n')
300
memento = push_log_file(brz_log_file,
301
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
302
r'%Y-%m-%d %H:%M:%S')
303
# after hooking output into brz_log, we also need to attach a stderr
304
# handler, writing only at level info and with encoding
305
if sys.version_info[0] == 2:
306
stderr_handler = EncodedStreamHandler(sys.stderr,
307
osutils.get_terminal_encoding(), 'replace', level=logging.INFO)
309
stderr_handler = logging.StreamHandler(stream=sys.stderr)
310
logging.getLogger('brz').addHandler(stderr_handler)
314
def push_log_file(to_file, log_format=None, date_format=None):
315
"""Intercept log and trace messages and send them to a file.
317
:param to_file: A file-like object to which messages will be sent.
319
:returns: A memento that should be passed to _pop_log_file to restore the
320
previously active logging.
324
new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
325
if log_format is None:
326
log_format = '%(levelname)8s %(message)s'
327
new_handler.setFormatter(logging.Formatter(log_format, date_format))
328
# save and remove any existing log handlers
329
brz_logger = logging.getLogger('brz')
330
old_handlers = brz_logger.handlers[:]
331
del brz_logger.handlers[:]
332
# set that as the default logger
333
brz_logger.addHandler(new_handler)
334
brz_logger.setLevel(logging.DEBUG)
335
# TODO: check if any changes are needed to the root logger
337
# TODO: also probably need to save and restore the level on brz_logger.
338
# but maybe we can avoid setting the logger level altogether, and just set
339
# the level on the handler?
341
# save the old trace file
342
old_trace_file = _trace_file
343
# send traces to the new one
344
_trace_file = to_file
345
result = new_handler, _trace_file
346
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
349
def pop_log_file(entry):
350
"""Undo changes to logging/tracing done by _push_log_file.
352
This flushes, but does not close the trace file (so that anything that was
355
Takes the memento returned from _push_log_file."""
356
(magic, old_handlers, new_handler, old_trace_file, new_trace_file) = entry
358
_trace_file = old_trace_file
359
brz_logger = logging.getLogger('brz')
360
brz_logger.removeHandler(new_handler)
361
# must be closed, otherwise logging will try to close it at exit, and the
362
# file will likely already be closed underneath.
364
brz_logger.handlers = old_handlers
365
if new_trace_file is not None:
366
new_trace_file.flush()
159
#tf = codecs.open(trace_fname, 'at', 'utf8', buffering=LINE_BUFFERED)
160
tf = open(trace_fname, 'at', LINE_BUFFERED)
162
# tf.tell() on windows always return 0 until some writing done
165
tf.write("this is a debug log for diagnosing/reporting problems in bzr\n")
166
tf.write("you can delete or truncate this file, or include sections in\n")
167
tf.write("bug reports to bazaar@lists.canonical.com\n\n")
168
_file_handler = logging.StreamHandler(tf)
169
fmt = r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s'
170
datefmt = r'%a %H:%M:%S'
171
_file_handler.setFormatter(logging.Formatter(fmt, datefmt))
172
_file_handler.setLevel(logging.DEBUG)
173
logging.getLogger('').addHandler(_file_handler)
175
warning("failed to open trace file: %s" % (e))
178
@deprecated_function(zero_nine)
179
def log_exception(msg=None):
180
"""Log the last exception to stderr and the trace file.
182
The exception string representation is used as the error
183
summary, unless msg is given.
185
Please see log_exception_quietly() for the replacement API.
189
log_exception_quietly()
369
192
def log_exception_quietly():
370
193
"""Log the last exception to the trace file only.
372
Used for exceptions that occur internally and that may be
373
interesting to developers but not to users. For example,
195
Used for exceptions that occur internally and that may be
196
interesting to developers but not to users. For example,
374
197
errors loading plugins.
376
200
mutter(traceback.format_exc())
379
def set_verbosity_level(level):
380
"""Set the verbosity level.
382
:param level: -ve for quiet, 0 for normal, +ve for verbose
384
global _verbosity_level
385
_verbosity_level = level
386
_update_logging_level(level < 0)
387
ui.ui_factory.be_quiet(level < 0)
390
def get_verbosity_level():
391
"""Get the verbosity level.
393
See set_verbosity_level() for values.
395
return _verbosity_level
203
def enable_default_logging():
204
"""Configure default logging to stderr and .bzr.log"""
205
# FIXME: if this is run twice, things get confused
206
global _stderr_handler, _file_handler, _trace_file, _bzr_log_file
207
_stderr_handler = logging.StreamHandler()
208
logging.getLogger('').addHandler(_stderr_handler)
209
_stderr_handler.setLevel(logging.INFO)
210
if not _file_handler:
212
_trace_file = _bzr_log_file
214
_file_handler.setLevel(logging.DEBUG)
215
_bzr_logger.setLevel(logging.DEBUG)
398
218
def be_quiet(quiet=True):
400
set_verbosity_level(-1)
402
set_verbosity_level(0)
405
def _update_logging_level(quiet=True):
406
"""Hide INFO messages if quiet."""
408
_brz_logger.setLevel(logging.WARNING)
410
_brz_logger.setLevel(logging.INFO)
219
global _stderr_handler, _stderr_quiet
221
_stderr_quiet = quiet
223
_stderr_handler.setLevel(logging.WARNING)
225
_stderr_handler.setLevel(logging.INFO)
414
"""Is the verbosity level negative?"""
415
return _verbosity_level < 0
419
"""Is the verbosity level positive?"""
420
return _verbosity_level > 0
423
def debug_memory(message='', short=True):
424
"""Write out a memory dump."""
425
if sys.platform == 'win32':
426
from breezy import win32utils
427
win32utils.debug_memory_win32api(message=message, short=short)
429
_debug_memory_proc(message=message, short=short)
432
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
434
def _debug_memory_proc(message='', short=True):
436
status_file = open('/proc/%s/status' % os.getpid(), 'rb')
440
status = status_file.read()
445
for line in status.splitlines():
449
for field in _short_fields:
450
if line.startswith(field):
454
def _dump_memory_usage(err_file):
457
fd, name = tempfile.mkstemp(prefix="brz_memdump", suffix=".json")
458
dump_file = os.fdopen(fd, 'w')
459
from meliae import scanner
460
scanner.dump_gc_objects(dump_file)
461
err_file.write("Memory dumped to %s\n" % name)
463
err_file.write("Dumping memory requires meliae module.\n")
464
log_exception_quietly()
466
err_file.write("Exception while dumping memory.\n")
467
log_exception_quietly()
469
if dump_file is not None:
475
def _qualified_exception_name(eclass, unqualified_breezy_errors=False):
476
"""Give name of error class including module for non-builtin exceptions
478
If `unqualified_breezy_errors` is True, errors specific to breezy will
479
also omit the module prefix.
481
class_name = eclass.__name__
482
module_name = eclass.__module__
483
if module_name in ("builtins", "exceptions", "__main__") or (
484
unqualified_breezy_errors and module_name == "breezy.errors"):
486
return "%s.%s" % (module_name, class_name)
233
def disable_default_logging():
234
"""Turn off default log handlers.
236
This is intended to be used by the test framework, which doesn't
237
want leakage from the code-under-test into the main logs.
240
l = logging.getLogger('')
241
l.removeHandler(_stderr_handler)
243
l.removeHandler(_file_handler)
247
def enable_test_log(to_file):
248
"""Redirect logging to a temporary file for a test
250
returns an opaque reference that should be passed to disable_test_log
251
after the test completes.
253
disable_default_logging()
256
hdlr = logging.StreamHandler(to_file)
257
hdlr.setLevel(logging.DEBUG)
258
hdlr.setFormatter(logging.Formatter('%(levelname)8s %(message)s'))
259
_bzr_logger.addHandler(hdlr)
260
_bzr_logger.setLevel(logging.DEBUG)
261
result = hdlr, _trace_file, _trace_depth
262
_trace_file = to_file
267
def disable_test_log((test_log_hdlr, old_trace_file, old_trace_depth)):
268
_bzr_logger.removeHandler(test_log_hdlr)
269
test_log_hdlr.close()
272
_trace_file = old_trace_file
273
_trace_depth = old_trace_depth
275
enable_default_logging()
489
278
def report_exception(exc_info, err_file):
490
"""Report an exception to err_file (typically stderr) and to .brz.log.
492
This will show either a full traceback or a short message as appropriate.
494
:return: The appropriate exit code for this error.
496
# Log the full traceback to ~/.brz.log
279
exc_type, exc_object, exc_tb = exc_info
280
# Log the full traceback to ~/.bzr.log
497
281
log_exception_quietly()
498
if 'error' in debug.debug_flags:
499
print_exception(exc_info, err_file)
500
return errors.EXIT_ERROR
501
exc_type, exc_object, exc_tb = exc_info
502
if isinstance(exc_object, KeyboardInterrupt):
503
err_file.write("brz: interrupted\n")
504
return errors.EXIT_ERROR
505
elif isinstance(exc_object, MemoryError):
506
err_file.write("brz: out of memory\n")
507
if 'mem_dump' in debug.debug_flags:
508
_dump_memory_usage(err_file)
510
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
511
return errors.EXIT_ERROR
512
elif isinstance(exc_object, ImportError) \
513
and str(exc_object).startswith("No module named "):
514
report_user_error(exc_info, err_file,
515
'You may need to install this Python library separately.')
516
return errors.EXIT_ERROR
282
if (isinstance(exc_object, IOError)
283
and getattr(exc_object, 'errno', None) == errno.EPIPE):
284
print >>err_file, "bzr: broken pipe"
285
elif isinstance(exc_object, KeyboardInterrupt):
286
print >>err_file, "bzr: interrupted"
517
287
elif not getattr(exc_object, 'internal_error', True):
518
288
report_user_error(exc_info, err_file)
519
return errors.EXIT_ERROR
520
elif osutils.is_environment_error(exc_object):
521
if getattr(exc_object, 'errno', None) == errno.EPIPE:
522
err_file.write("brz: broken pipe\n")
523
return errors.EXIT_ERROR
289
elif isinstance(exc_object, (OSError, IOError)):
524
290
# Might be nice to catch all of these and show them as something more
525
291
# specific, but there are too many cases at the moment.
526
292
report_user_error(exc_info, err_file)
527
return errors.EXIT_ERROR
529
294
report_bug(exc_info, err_file)
530
return errors.EXIT_INTERNAL_ERROR
533
def print_exception(exc_info, err_file):
534
exc_type, exc_object, exc_tb = exc_info
535
err_file.write("brz: ERROR: %s: %s\n" % (
536
_qualified_exception_name(exc_type), exc_object))
538
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
541
297
# TODO: Should these be specially encoding the output?
542
def report_user_error(exc_info, err_file, advice=None):
298
def report_user_error(exc_info, err_file):
543
299
"""Report to err_file an error that's not an internal error.
545
301
These don't get a traceback unless -Derror was given.
547
:param exc_info: 3-tuple from sys.exc_info()
548
:param advice: Extra advice to the user to be printed following the
551
err_file.write(("brz: ERROR: %s\n" % (str(exc_info[1]),)))
553
err_file.write(("%s\n" % advice))
303
if 'error' in debug.debug_flags:
304
report_bug(exc_info, err_file)
306
print >>err_file, "bzr: ERROR:", str(exc_info[1])
556
309
def report_bug(exc_info, err_file):
557
"""Report an exception that probably indicates a bug in brz"""
558
from breezy.crash import report_bug
559
report_bug(exc_info, err_file)
562
def _flush_stdout_stderr():
563
# called from the breezy library finalizer returned by breezy.initialize()
567
except ValueError as e:
568
# On Windows, I get ValueError calling stdout.flush() on a closed
573
if e.errno in [errno.EINVAL, errno.EPIPE]:
580
# called from the breezy library finalizer returned by breezy.initialize()
586
class EncodedStreamHandler(logging.Handler):
587
"""Robustly write logging events to a stream using the specified encoding
589
Messages are expected to be formatted to unicode, but UTF-8 byte strings
590
are also accepted. An error during formatting or a str message in another
591
encoding will be quitely noted as an error in the Bazaar log file.
593
The stream is not closed so sys.stdout or sys.stderr may be passed.
596
def __init__(self, stream, encoding=None, errors='strict', level=0):
597
logging.Handler.__init__(self, level)
600
encoding = getattr(stream, "encoding", "ascii")
601
self.encoding = encoding
605
flush = getattr(self.stream, "flush", None)
606
if flush is not None:
609
def emit(self, record):
611
if not isinstance(record.msg, text_type):
612
msg = record.msg.decode("utf-8")
615
line = self.format(record)
616
if not isinstance(line, text_type):
617
line = line.decode("utf-8")
618
self.stream.write(line.encode(self.encoding, self.errors) + b"\n")
620
log_exception_quietly()
621
# Try saving the details that would have been logged in some form
622
msg = args = "<Unformattable>"
624
msg = repr(record.msg)
625
args = repr(record.args)
628
# Using mutter() bypasses the logging module and writes directly
629
# to the file so there's no danger of getting into a loop here.
630
mutter("Logging record unformattable: %s %% %s", msg, args)
633
class Config(object):
634
"""Configuration of message tracing in breezy.
636
This implements the context manager protocol and should manage any global
637
variables still used. The default config used is DefaultConfig, but
638
embedded uses of breezy may wish to use a custom manager.
642
return self # This is bound to the 'as' clause in a with statement.
644
def __exit__(self, exc_type, exc_val, exc_tb):
645
return False # propogate exceptions.
648
class DefaultConfig(Config):
649
"""A default configuration for tracing of messages in breezy.
651
This implements the context manager protocol.
655
self._original_filename = _brz_log_filename
656
self._original_state = enable_default_logging()
657
return self # This is bound to the 'as' clause in a with statement.
659
def __exit__(self, exc_type, exc_val, exc_tb):
660
pop_log_file(self._original_state)
661
global _brz_log_filename
662
_brz_log_filename = self._original_filename
663
return False # propogate exceptions.
310
"""Report an exception that probably indicates a bug in bzr"""
312
exc_type, exc_object, exc_tb = exc_info
313
print >>err_file, "bzr: ERROR: %s.%s: %s" % (
314
exc_type.__module__, exc_type.__name__, exc_object)
316
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
318
print >>err_file, 'bzr %s on python %s (%s)' % \
320
'.'.join(map(str, sys.version_info)),
322
print >>err_file, 'arguments: %r' % sys.argv
324
print >>err_file, "** please send this report to bazaar@lists.ubuntu.com"
added
removed
bzrlib/trace.py
