23
23
Messages are classified by severity levels: critical, error, warning, info,
26
They can be sent to two places: to stderr, and to ~/.bzr.log. For purposes
26
They can be sent to two places: to stderr, and to ~/.brz.log. For purposes
27
27
such as running the test suite, they can also be redirected away from both of
28
28
those two places to another location.
30
~/.bzr.log gets all messages, and full tracebacks for uncaught exceptions.
30
~/.brz.log gets all messages, and full tracebacks for uncaught exceptions.
31
31
This trace file is always in UTF-8, regardless of the user's default encoding,
32
32
so that we can always rely on writing any message.
54
56
# increased cost of logging.py is not so bad, and we could standardize on
63
from bzrlib.lazy_import import lazy_import
64
from breezy.lazy_import import lazy_import
64
65
lazy_import(globals(), """
65
66
from cStringIO import StringIO
73
from bzrlib.symbol_versioning import (
78
75
lazy_import(globals(), """
90
# global verbosity for bzrlib; controls the log level for stderr; 0=normal; <0
85
# global verbosity for breezy; controls the log level for stderr; 0=normal; <0
91
86
# is quiet; >0 is verbose.
92
87
_verbosity_level = 0
97
92
# than push/pop_log_file.
100
# Absolute path for ~/.bzr.log. Not changed even if the log/trace output is
95
# Absolute path for ~/.brz.log. Not changed even if the log/trace output is
101
96
# redirected elsewhere. Used to show the location in --version.
102
_bzr_log_filename = None
97
_brz_log_filename = None
104
99
# The time the first message was written to the trace file, so that we can
105
100
# show relative times since startup.
106
_bzr_log_start_time = bzrlib._start_time
101
_brz_log_start_time = breezy._start_time
109
104
# held in a global for quick reference
110
_bzr_logger = logging.getLogger('bzr')
105
_brz_logger = logging.getLogger('brz')
113
108
def note(*args, **kwargs):
120
# FIXME note always emits utf-8, regardless of the terminal encoding
122
115
# FIXME: clearing the ui and then going through the abstract logging
123
116
# framework is whack; we should probably have a logging Handler that
124
117
# deals with terminal output if needed.
126
bzrlib.ui.ui_factory.clear_term()
127
_bzr_logger.info(*args, **kwargs)
118
ui.ui_factory.clear_term()
119
_brz_logger.info(*args, **kwargs)
130
122
def warning(*args, **kwargs):
132
bzrlib.ui.ui_factory.clear_term()
133
_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)
123
ui.ui_factory.clear_term()
124
_brz_logger.warning(*args, **kwargs)
154
127
def show_error(*args, **kwargs):
223
def _get_bzr_log_filename():
224
bzr_log = os.environ.get('BZR_LOG')
227
home = os.environ.get('BZR_HOME')
196
def _get_brz_log_filename():
197
brz_log = osutils.path_from_environ('BRZ_LOG')
200
home = osutils.path_from_environ('BRZ_HOME')
229
if sys.platform == 'win32':
230
from bzrlib import win32utils
231
home = win32utils.get_home_location()
233
home = os.path.expanduser('~')
234
return os.path.join(home, '.bzr.log')
238
"""Open the .bzr.log trace file.
202
# GZ 2012-02-01: Logging to the home dir is bad, but XDG is unclear
203
# over what would be better. On windows, bug 240550
204
# suggests LOCALAPPDATA be used instead.
205
home = osutils._get_home_dir()
206
return os.path.join(home, '.brz.log')
210
"""Open the .brz.log trace file.
240
212
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
213
.brz.log.old and a new file is started. Otherwise, we append to the
244
This sets the global _bzr_log_filename.
216
This sets the global _brz_log_filename.
246
global _bzr_log_filename
218
global _brz_log_filename
248
220
def _open_or_create_log_file(filename):
249
221
"""Open existing log file, or create with ownership and permissions
269
241
osutils.copy_ownership_from_path(filename)
271
return os.fdopen(fd, 'at', 0) # unbuffered
274
_bzr_log_filename = _get_bzr_log_filename()
275
_rollover_trace_maybe(_bzr_log_filename)
243
return os.fdopen(fd, 'at', 0) # unbuffered
245
_brz_log_filename = _get_brz_log_filename()
246
_rollover_trace_maybe(_brz_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")
248
brz_log_file = _open_or_create_log_file(_brz_log_filename)
249
brz_log_file.write('\n')
250
if brz_log_file.tell() <= 2:
251
brz_log_file.write("this is a debug log for diagnosing/reporting problems in brz\n")
252
brz_log_file.write("you can delete or truncate this file, or include sections in\n")
253
brz_log_file.write("bug reports to https://bugs.launchpad.net/brz/+filebug\n\n")
286
257
except EnvironmentError, e:
287
258
# If we are failing to open the log, then most likely logging has not
288
259
# been set up yet. So we just write to stderr rather than using
289
260
# 'warning()'. If we using warning(), users get the unhelpful 'no
290
# handlers registered for "bzr"' when something goes wrong on the
261
# handlers registered for "brz"' when something goes wrong on the
291
262
# server. (bug #503886)
292
263
sys.stderr.write("failed to open trace file: %s\n" % (e,))
293
264
# TODO: What should happen if we fail to open the trace file? Maybe the
299
270
def enable_default_logging():
300
"""Configure default logging: messages to stderr and debug to .bzr.log
271
"""Configure default logging: messages to stderr and debug to .brz.log
302
273
This should only be called once per process.
304
Non-command-line programs embedding bzrlib do not need to call this. They
275
Non-command-line programs embedding breezy do not need to call this. They
305
276
can instead either pass a file to _push_log_file, or act directly on
306
logging.getLogger("bzr").
277
logging.getLogger("brz").
308
279
Output can be redirected away by calling _push_log_file.
281
:return: A memento from push_log_file for restoring the log state.
310
# Do this before we open the log file, so we prevent
311
# get_terminal_encoding() from mutter()ing multiple times
312
term_encoding = osutils.get_terminal_encoding()
313
start_time = osutils.format_local_date(_bzr_log_start_time,
283
start_time = osutils.format_local_date(_brz_log_start_time,
314
284
timezone='local')
315
# create encoded wrapper around stderr
316
bzr_log_file = _open_bzr_log()
317
if bzr_log_file is not None:
318
bzr_log_file.write(start_time.encode('utf-8') + '\n')
319
push_log_file(bzr_log_file,
285
brz_log_file = _open_brz_log()
286
if brz_log_file is not None:
287
brz_log_file.write(start_time.encode('utf-8') + '\n')
288
memento = push_log_file(brz_log_file,
320
289
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
321
290
r'%Y-%m-%d %H:%M:%S')
322
# after hooking output into bzr_log, we also need to attach a stderr
291
# after hooking output into brz_log, we also need to attach a stderr
323
292
# handler, writing only at level info and with 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)
293
stderr_handler = EncodedStreamHandler(sys.stderr,
294
osutils.get_terminal_encoding(), 'replace', level=logging.INFO)
295
logging.getLogger('brz').addHandler(stderr_handler)
331
299
def push_log_file(to_file, log_format=None, date_format=None):
334
302
:param to_file: A file-like object to which messages will be sent.
336
304
:returns: A memento that should be passed to _pop_log_file to restore the
337
previously active logging.
305
previously active logging.
339
307
global _trace_file
340
308
# make a new handler
341
new_handler = logging.StreamHandler(to_file)
342
new_handler.setLevel(logging.DEBUG)
309
new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
343
310
if log_format is None:
344
311
log_format = '%(levelname)8s %(message)s'
345
312
new_handler.setFormatter(logging.Formatter(log_format, date_format))
346
313
# save and remove any existing log handlers
347
bzr_logger = logging.getLogger('bzr')
348
old_handlers = bzr_logger.handlers[:]
349
del bzr_logger.handlers[:]
314
brz_logger = logging.getLogger('brz')
315
old_handlers = brz_logger.handlers[:]
316
del brz_logger.handlers[:]
350
317
# set that as the default logger
351
bzr_logger.addHandler(new_handler)
352
bzr_logger.setLevel(logging.DEBUG)
318
brz_logger.addHandler(new_handler)
319
brz_logger.setLevel(logging.DEBUG)
353
320
# TODO: check if any changes are needed to the root logger
355
# TODO: also probably need to save and restore the level on bzr_logger.
322
# TODO: also probably need to save and restore the level on brz_logger.
356
323
# but maybe we can avoid setting the logger level altogether, and just set
357
324
# the level on the handler?
367
334
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
368
335
"""Undo changes to logging/tracing done by _push_log_file.
370
This flushes, but does not close the trace file.
337
This flushes, but does not close the trace file (so that anything that was
372
340
Takes the memento returned from _push_log_file."""
373
341
global _trace_file
374
342
_trace_file = old_trace_file
375
bzr_logger = logging.getLogger('bzr')
376
bzr_logger.removeHandler(new_handler)
377
# must be closed, otherwise logging will try to close it atexit, and the
343
brz_logger = logging.getLogger('brz')
344
brz_logger.removeHandler(new_handler)
345
# must be closed, otherwise logging will try to close it at exit, and the
378
346
# file will likely already be closed underneath.
379
347
new_handler.close()
380
bzr_logger.handlers = old_handlers
381
new_trace_file.flush()
348
brz_logger.handlers = old_handlers
349
if new_trace_file is not None:
350
new_trace_file.flush()
384
353
def log_exception_quietly():
438
407
def debug_memory(message='', short=True):
439
408
"""Write out a memory dump."""
440
409
if sys.platform == 'win32':
441
from bzrlib import win32utils
410
from breezy import win32utils
442
411
win32utils.debug_memory_win32api(message=message, short=short)
444
413
_debug_memory_proc(message=message, short=short)
438
def _dump_memory_usage(err_file):
441
fd, name = tempfile.mkstemp(prefix="brz_memdump", suffix=".json")
442
dump_file = os.fdopen(fd, 'w')
443
from meliae import scanner
444
scanner.dump_gc_objects(dump_file)
445
err_file.write("Memory dumped to %s\n" % name)
447
err_file.write("Dumping memory requires meliae module.\n")
448
log_exception_quietly()
450
err_file.write("Exception while dumping memory.\n")
451
log_exception_quietly()
453
if dump_file is not None:
459
def _qualified_exception_name(eclass, unqualified_breezy_errors=False):
460
"""Give name of error class including module for non-builtin exceptions
462
If `unqualified_breezy_errors` is True, errors specific to breezy will
463
also omit the module prefix.
465
class_name = eclass.__name__
466
module_name = eclass.__module__
467
if module_name in ("exceptions", "__main__") or (
468
unqualified_breezy_errors and module_name == "breezy.errors"):
470
return "%s.%s" % (module_name, class_name)
470
473
def report_exception(exc_info, err_file):
471
"""Report an exception to err_file (typically stderr) and to .bzr.log.
474
"""Report an exception to err_file (typically stderr) and to .brz.log.
473
476
This will show either a full traceback or a short message as appropriate.
475
478
:return: The appropriate exit code for this error.
477
# Log the full traceback to ~/.bzr.log
480
# Log the full traceback to ~/.brz.log
478
481
log_exception_quietly()
479
482
if 'error' in debug.debug_flags:
480
483
print_exception(exc_info, err_file)
481
484
return errors.EXIT_ERROR
482
485
exc_type, exc_object, exc_tb = exc_info
483
if (isinstance(exc_object, IOError)
484
and getattr(exc_object, 'errno', None) == errno.EPIPE):
485
err_file.write("bzr: broken pipe\n")
486
return errors.EXIT_ERROR
487
elif isinstance(exc_object, KeyboardInterrupt):
488
err_file.write("bzr: interrupted\n")
486
if isinstance(exc_object, KeyboardInterrupt):
487
err_file.write("brz: interrupted\n")
489
488
return errors.EXIT_ERROR
490
489
elif isinstance(exc_object, MemoryError):
491
err_file.write("bzr: out of memory\n")
490
err_file.write("brz: out of memory\n")
491
if 'mem_dump' in debug.debug_flags:
492
_dump_memory_usage(err_file)
494
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
492
495
return errors.EXIT_ERROR
493
496
elif isinstance(exc_object, ImportError) \
494
497
and str(exc_object).startswith("No module named "):
498
501
elif not getattr(exc_object, 'internal_error', True):
499
502
report_user_error(exc_info, err_file)
500
503
return errors.EXIT_ERROR
501
elif isinstance(exc_object, (OSError, IOError)):
504
elif osutils.is_environment_error(exc_object):
505
if getattr(exc_object, 'errno', None) == errno.EPIPE:
506
err_file.write("brz: broken pipe\n")
507
return errors.EXIT_ERROR
502
508
# Might be nice to catch all of these and show them as something more
503
509
# specific, but there are too many cases at the moment.
504
510
report_user_error(exc_info, err_file)
511
517
def print_exception(exc_info, err_file):
512
518
exc_type, exc_object, exc_tb = exc_info
513
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
519
err_file.write("brz: ERROR: %s.%s: %s\n" % (
514
520
exc_type.__module__, exc_type.__name__, exc_object))
515
521
err_file.write('\n')
516
522
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
526
532
:param advice: Extra advice to the user to be printed following the
529
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
535
err_file.write("brz: ERROR: %s\n" % (exc_info[1],))
531
537
err_file.write("%s\n" % (advice,))
534
540
def report_bug(exc_info, err_file):
535
"""Report an exception that probably indicates a bug in bzr"""
536
from bzrlib.crash import report_bug
541
"""Report an exception that probably indicates a bug in brz"""
542
from breezy.crash import report_bug
537
543
report_bug(exc_info, err_file)
540
546
def _flush_stdout_stderr():
541
# installed into an atexit hook by bzrlib.initialize()
547
# called from the breezy library finalizer returned by breezy.initialize()
543
549
sys.stdout.flush()
544
550
sys.stderr.flush()
551
except ValueError, e:
552
# On Windows, I get ValueError calling stdout.flush() on a closed
545
555
except IOError, e:
547
557
if e.errno in [errno.EINVAL, errno.EPIPE]:
553
563
def _flush_trace():
554
# run from atexit hook
564
# called from the breezy library finalizer returned by breezy.initialize()
555
565
global _trace_file
557
567
_trace_file.flush()
570
class EncodedStreamHandler(logging.Handler):
571
"""Robustly write logging events to a stream using the specified encoding
573
Messages are expected to be formatted to unicode, but UTF-8 byte strings
574
are also accepted. An error during formatting or a str message in another
575
encoding will be quitely noted as an error in the Bazaar log file.
577
The stream is not closed so sys.stdout or sys.stderr may be passed.
580
def __init__(self, stream, encoding=None, errors='strict', level=0):
581
logging.Handler.__init__(self, level)
584
encoding = getattr(stream, "encoding", "ascii")
585
self.encoding = encoding
589
flush = getattr(self.stream, "flush", None)
590
if flush is not None:
593
def emit(self, record):
595
line = self.format(record)
596
if not isinstance(line, unicode):
597
line = line.decode("utf-8")
598
self.stream.write(line.encode(self.encoding, self.errors) + "\n")
600
log_exception_quietly()
601
# Try saving the details that would have been logged in some form
602
msg = args = "<Unformattable>"
604
msg = repr(record.msg).encode("ascii")
605
args = repr(record.args).encode("ascii")
608
# Using mutter() bypasses the logging module and writes directly
609
# to the file so there's no danger of getting into a loop here.
610
mutter("Logging record unformattable: %s %% %s", msg, args)
613
class Config(object):
614
"""Configuration of message tracing in breezy.
616
This implements the context manager protocol and should manage any global
617
variables still used. The default config used is DefaultConfig, but
618
embedded uses of breezy may wish to use a custom manager.
622
return self # This is bound to the 'as' clause in a with statement.
624
def __exit__(self, exc_type, exc_val, exc_tb):
625
return False # propogate exceptions.
628
class DefaultConfig(Config):
629
"""A default configuration for tracing of messages in breezy.
631
This implements the context manager protocol.
635
self._original_filename = _brz_log_filename
636
self._original_state = enable_default_logging()
637
return self # This is bound to the 'as' clause in a with statement.
639
def __exit__(self, exc_type, exc_val, exc_tb):
640
pop_log_file(self._original_state)
641
global _brz_log_filename
642
_brz_log_filename = self._original_filename
643
return False # propogate exceptions.
added
removed
breezy/trace.py
