23
23
Messages are classified by severity levels: critical, error, warning, info,
26
They can be sent to two places: stderr, and `$XDG_CACHE_HOME/breezy/brz.log`.
27
For purposes such as running the test suite, they can also be redirected away
28
from both of those two places to another location.
26
They can be sent to two places: to stderr, and to ~/.bzr.log. For purposes
27
such as running the test suite, they can also be redirected away from both of
28
those two places to another location.
30
`brz.log` gets all messages, and full tracebacks for uncaught exceptions.
30
~/.bzr.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.
56
54
# increased cost of logging.py is not so bad, and we could standardize on
65
from .lazy_import import lazy_import
63
from bzrlib.lazy_import import lazy_import
66
64
lazy_import(globals(), """
65
from cStringIO import StringIO
73
from bzrlib.symbol_versioning import (
73
78
lazy_import(globals(), """
90
# global verbosity for breezy; controls the log level for stderr; 0=normal; <0
90
# global verbosity for bzrlib; controls the log level for stderr; 0=normal; <0
91
91
# is quiet; >0 is verbose.
92
92
_verbosity_level = 0
97
97
# than push/pop_log_file.
100
# Absolute path for brz.log. Not changed even if the log/trace output is
100
# Absolute path for ~/.bzr.log. Not changed even if the log/trace output is
101
101
# redirected elsewhere. Used to show the location in --version.
102
_brz_log_filename = None
102
_bzr_log_filename = None
104
104
# The time the first message was written to the trace file, so that we can
105
105
# show relative times since startup.
106
_brz_log_start_time = breezy._start_time
106
_bzr_log_start_time = bzrlib._start_time
109
109
# held in a global for quick reference
110
_brz_logger = logging.getLogger('brz')
110
_bzr_logger = logging.getLogger('bzr')
113
113
def note(*args, **kwargs):
114
"""Output a note to the user.
116
Takes the same parameters as logging.info.
114
# FIXME note always emits utf-8, regardless of the terminal encoding
120
116
# FIXME: clearing the ui and then going through the abstract logging
121
117
# framework is whack; we should probably have a logging Handler that
122
118
# deals with terminal output if needed.
123
ui.ui_factory.clear_term()
124
_brz_logger.info(*args, **kwargs)
120
bzrlib.ui.ui_factory.clear_term()
121
_bzr_logger.info(*args, **kwargs)
127
124
def warning(*args, **kwargs):
128
ui.ui_factory.clear_term()
129
_brz_logger.warning(*args, **kwargs)
126
bzrlib.ui.ui_factory.clear_term()
127
_bzr_logger.warning(*args, **kwargs)
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)
132
148
def show_error(*args, **kwargs):
155
161
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
158
# Let format strings be specified as ascii bytes to help Python 2
159
if isinstance(fmt, bytes):
160
fmt = fmt.decode('ascii', 'replace')
164
if isinstance(fmt, unicode):
165
fmt = fmt.encode('utf8')
165
_Bytes(arg) if isinstance(arg, bytes) else arg for arg in args)
168
# It seems that if we do ascii % (unicode, ascii) we can
169
# get a unicode cannot encode ascii error, so make sure that "fmt"
170
# is a unicode string
173
if isinstance(arg, unicode):
174
arg = arg.encode('utf8')
175
real_args.append(arg)
176
out = fmt % tuple(real_args)
169
179
now = time.time()
170
out = '%0.3f %s\n' % (now - _brz_log_start_time, out)
171
_trace_file.write(out.encode('utf-8'))
180
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
181
out = timestamp + out + '\n'
182
_trace_file.write(out)
172
183
# there's no explicit flushing; the file is typically line buffered.
206
def _get_brz_log_filename():
207
"""Return the brz log filename.
209
:return: A path to the log file
210
:raise EnvironmentError: If the cache directory could not be created
212
brz_log = osutils.path_from_environ('BRZ_LOG')
215
return os.path.join(bedding.cache_dir(), 'brz.log')
219
"""Open the brz.log trace file.
217
def _get_bzr_log_filename():
218
bzr_log = os.environ.get('BZR_LOG')
221
home = os.environ.get('BZR_HOME')
223
if sys.platform == 'win32':
224
from bzrlib import win32utils
225
home = win32utils.get_home_location()
227
home = os.path.expanduser('~')
228
return os.path.join(home, '.bzr.log')
232
"""Open the .bzr.log trace file.
221
234
If the log is more than a particular length, the old file is renamed to
222
brz.log.old and a new file is started. Otherwise, we append to the
235
.bzr.log.old and a new file is started. Otherwise, we append to the
225
This sets the global _brz_log_filename.
238
This sets the global _bzr_log_filename.
227
global _brz_log_filename
240
global _bzr_log_filename
229
242
def _open_or_create_log_file(filename):
230
243
"""Open existing log file, or create with ownership and permissions
239
252
fd = os.open(filename, flags)
242
255
if e.errno != errno.ENOENT:
245
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0o666)
258
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
247
260
if e.errno != errno.EEXIST:
250
263
osutils.copy_ownership_from_path(filename)
252
return os.fdopen(fd, 'ab', 0) # unbuffered
265
return os.fdopen(fd, 'at', 0) # unbuffered
268
_bzr_log_filename = _get_bzr_log_filename()
269
_rollover_trace_maybe(_bzr_log_filename)
255
_brz_log_filename = _get_brz_log_filename()
256
_rollover_trace_maybe(_brz_log_filename)
258
brz_log_file = _open_or_create_log_file(_brz_log_filename)
259
brz_log_file.write(b'\n')
260
if brz_log_file.tell() <= 2:
262
b"this is a debug log for diagnosing/reporting problems in brz\n")
264
b"you can delete or truncate this file, or include sections in\n")
266
b"bug reports to https://bugs.launchpad.net/brz/+filebug\n\n")
270
except EnvironmentError as e:
271
bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
272
bzr_log_file.write('\n')
273
if bzr_log_file.tell() <= 2:
274
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
275
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
276
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
280
except EnvironmentError, e:
271
281
# If we are failing to open the log, then most likely logging has not
272
282
# been set up yet. So we just write to stderr rather than using
273
283
# 'warning()'. If we using warning(), users get the unhelpful 'no
274
# handlers registered for "brz"' when something goes wrong on the
284
# handlers registered for "bzr"' when something goes wrong on the
275
285
# server. (bug #503886)
276
286
sys.stderr.write("failed to open trace file: %s\n" % (e,))
277
287
# TODO: What should happen if we fail to open the trace file? Maybe the
283
293
def enable_default_logging():
284
"""Configure default logging: messages to stderr and debug to brz.log
294
"""Configure default logging: messages to stderr and debug to .bzr.log
286
296
This should only be called once per process.
288
Non-command-line programs embedding breezy do not need to call this. They
298
Non-command-line programs embedding bzrlib do not need to call this. They
289
299
can instead either pass a file to _push_log_file, or act directly on
290
logging.getLogger("brz").
300
logging.getLogger("bzr").
292
302
Output can be redirected away by calling _push_log_file.
294
:return: A memento from push_log_file for restoring the log state.
296
start_time = osutils.format_local_date(_brz_log_start_time,
304
# Do this before we open the log file, so we prevent
305
# get_terminal_encoding() from mutter()ing multiple times
306
term_encoding = osutils.get_terminal_encoding()
307
start_time = osutils.format_local_date(_bzr_log_start_time,
297
308
timezone='local')
298
brz_log_file = _open_brz_log()
299
if brz_log_file is not None:
300
brz_log_file.write(start_time.encode('utf-8') + b'\n')
301
memento = push_log_file(
309
# create encoded wrapper around stderr
310
bzr_log_file = _open_bzr_log()
311
if bzr_log_file is not None:
312
bzr_log_file.write(start_time.encode('utf-8') + '\n')
313
push_log_file(bzr_log_file,
303
314
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
304
315
r'%Y-%m-%d %H:%M:%S')
305
# after hooking output into brz_log, we also need to attach a stderr
316
# after hooking output into bzr_log, we also need to attach a stderr
306
317
# handler, writing only at level info and with encoding
307
if sys.version_info[0] == 2:
308
stderr_handler = EncodedStreamHandler(
309
sys.stderr, osutils.get_terminal_encoding(), 'replace',
312
stderr_handler = logging.StreamHandler(stream=sys.stderr)
313
logging.getLogger('brz').addHandler(stderr_handler)
318
writer_factory = codecs.getwriter(term_encoding)
319
encoded_stderr = writer_factory(sys.stderr, errors='replace')
320
stderr_handler = logging.StreamHandler(encoded_stderr)
321
stderr_handler.setLevel(logging.INFO)
322
logging.getLogger('bzr').addHandler(stderr_handler)
317
325
def push_log_file(to_file, log_format=None, date_format=None):
320
328
:param to_file: A file-like object to which messages will be sent.
322
330
:returns: A memento that should be passed to _pop_log_file to restore the
323
previously active logging.
331
previously active logging.
325
333
global _trace_file
326
334
# make a new handler
327
new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
335
new_handler = logging.StreamHandler(to_file)
336
new_handler.setLevel(logging.DEBUG)
328
337
if log_format is None:
329
338
log_format = '%(levelname)8s %(message)s'
330
339
new_handler.setFormatter(logging.Formatter(log_format, date_format))
331
340
# save and remove any existing log handlers
332
brz_logger = logging.getLogger('brz')
333
old_handlers = brz_logger.handlers[:]
334
del brz_logger.handlers[:]
341
bzr_logger = logging.getLogger('bzr')
342
old_handlers = bzr_logger.handlers[:]
343
del bzr_logger.handlers[:]
335
344
# set that as the default logger
336
brz_logger.addHandler(new_handler)
337
brz_logger.setLevel(logging.DEBUG)
345
bzr_logger.addHandler(new_handler)
346
bzr_logger.setLevel(logging.DEBUG)
338
347
# TODO: check if any changes are needed to the root logger
340
# TODO: also probably need to save and restore the level on brz_logger.
349
# TODO: also probably need to save and restore the level on bzr_logger.
341
350
# but maybe we can avoid setting the logger level altogether, and just set
342
351
# the level on the handler?
345
354
old_trace_file = _trace_file
346
355
# send traces to the new one
347
356
_trace_file = to_file
357
result = new_handler, _trace_file
348
358
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
351
def pop_log_file(entry):
361
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
352
362
"""Undo changes to logging/tracing done by _push_log_file.
354
This flushes, but does not close the trace file (so that anything that was
364
This flushes, but does not close the trace file.
357
366
Takes the memento returned from _push_log_file."""
358
(magic, old_handlers, new_handler, old_trace_file, new_trace_file) = entry
359
367
global _trace_file
360
368
_trace_file = old_trace_file
361
brz_logger = logging.getLogger('brz')
362
brz_logger.removeHandler(new_handler)
363
# must be closed, otherwise logging will try to close it at exit, and the
369
bzr_logger = logging.getLogger('bzr')
370
bzr_logger.removeHandler(new_handler)
371
# must be closed, otherwise logging will try to close it atexit, and the
364
372
# file will likely already be closed underneath.
365
373
new_handler.close()
366
brz_logger.handlers = old_handlers
367
if new_trace_file is not None:
368
new_trace_file.flush()
374
bzr_logger.handlers = old_handlers
375
new_trace_file.flush()
371
378
def log_exception_quietly():
458
def _dump_memory_usage(err_file):
461
fd, name = tempfile.mkstemp(prefix="brz_memdump", suffix=".json")
462
dump_file = os.fdopen(fd, 'w')
463
from meliae import scanner
464
scanner.dump_gc_objects(dump_file)
465
err_file.write("Memory dumped to %s\n" % name)
467
err_file.write("Dumping memory requires meliae module.\n")
468
log_exception_quietly()
469
except BaseException:
470
err_file.write("Exception while dumping memory.\n")
471
log_exception_quietly()
473
if dump_file is not None:
479
def _qualified_exception_name(eclass, unqualified_breezy_errors=False):
480
"""Give name of error class including module for non-builtin exceptions
482
If `unqualified_breezy_errors` is True, errors specific to breezy will
483
also omit the module prefix.
485
class_name = eclass.__name__
486
module_name = eclass.__module__
487
if module_name in ("builtins", "exceptions", "__main__") or (
488
unqualified_breezy_errors and module_name == "breezy.errors"):
490
return "%s.%s" % (module_name, class_name)
493
464
def report_exception(exc_info, err_file):
494
"""Report an exception to err_file (typically stderr) and to brz.log.
465
"""Report an exception to err_file (typically stderr) and to .bzr.log.
496
467
This will show either a full traceback or a short message as appropriate.
498
469
:return: The appropriate exit code for this error.
500
# Log the full traceback to brz.log
471
# Log the full traceback to ~/.bzr.log
501
472
log_exception_quietly()
502
473
if 'error' in debug.debug_flags:
503
474
print_exception(exc_info, err_file)
504
475
return errors.EXIT_ERROR
505
476
exc_type, exc_object, exc_tb = exc_info
506
if isinstance(exc_object, KeyboardInterrupt):
507
err_file.write("brz: interrupted\n")
477
if (isinstance(exc_object, IOError)
478
and getattr(exc_object, 'errno', None) == errno.EPIPE):
479
err_file.write("bzr: broken pipe\n")
480
return errors.EXIT_ERROR
481
elif isinstance(exc_object, KeyboardInterrupt):
482
err_file.write("bzr: interrupted\n")
508
483
return errors.EXIT_ERROR
509
484
elif isinstance(exc_object, MemoryError):
510
err_file.write("brz: out of memory\n")
511
if 'mem_dump' in debug.debug_flags:
512
_dump_memory_usage(err_file)
514
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
485
err_file.write("bzr: out of memory\n")
515
486
return errors.EXIT_ERROR
516
487
elif isinstance(exc_object, ImportError) \
517
and str(exc_object).startswith("No module named "):
488
and str(exc_object).startswith("No module named "):
489
report_user_error(exc_info, err_file,
520
490
'You may need to install this Python library separately.')
521
491
return errors.EXIT_ERROR
522
492
elif not getattr(exc_object, 'internal_error', True):
523
493
report_user_error(exc_info, err_file)
524
494
return errors.EXIT_ERROR
525
elif osutils.is_environment_error(exc_object):
526
if getattr(exc_object, 'errno', None) == errno.EPIPE:
527
err_file.write("brz: broken pipe\n")
528
return errors.EXIT_ERROR
495
elif isinstance(exc_object, (OSError, IOError)):
529
496
# Might be nice to catch all of these and show them as something more
530
497
# specific, but there are too many cases at the moment.
531
498
report_user_error(exc_info, err_file)
538
505
def print_exception(exc_info, err_file):
539
506
exc_type, exc_object, exc_tb = exc_info
540
err_file.write("brz: ERROR: %s: %s\n" % (
541
_qualified_exception_name(exc_type), exc_object))
507
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
508
exc_type.__module__, exc_type.__name__, exc_object))
542
509
err_file.write('\n')
543
510
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
553
520
:param advice: Extra advice to the user to be printed following the
556
err_file.write(("brz: ERROR: %s\n" % (str(exc_info[1]),)))
523
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
558
err_file.write(("%s\n" % advice))
525
err_file.write("%s\n" % (advice,))
561
528
def report_bug(exc_info, err_file):
562
"""Report an exception that probably indicates a bug in brz"""
563
from breezy.crash import report_bug
529
"""Report an exception that probably indicates a bug in bzr"""
530
from bzrlib.crash import report_bug
564
531
report_bug(exc_info, err_file)
567
534
def _flush_stdout_stderr():
568
# called from the breezy library finalizer returned by breezy.initialize()
535
# installed into an atexit hook by bzrlib.initialize()
570
537
sys.stdout.flush()
571
538
sys.stderr.flush()
573
# On Windows, I get ValueError calling stdout.flush() on a closed
578
541
if e.errno in [errno.EINVAL, errno.EPIPE]:
584
547
def _flush_trace():
585
# called from the breezy library finalizer returned by breezy.initialize()
548
# run from atexit hook
586
549
global _trace_file
588
551
_trace_file.flush()
591
class EncodedStreamHandler(logging.Handler):
592
"""Robustly write logging events to a stream using the specified encoding
594
Messages are expected to be formatted to unicode, but UTF-8 byte strings
595
are also accepted. An error during formatting or a str message in another
596
encoding will be quitely noted as an error in the Bazaar log file.
598
The stream is not closed so sys.stdout or sys.stderr may be passed.
601
def __init__(self, stream, encoding=None, errors='strict', level=0):
602
logging.Handler.__init__(self, level)
605
encoding = getattr(stream, "encoding", "ascii")
606
self.encoding = encoding
610
flush = getattr(self.stream, "flush", None)
611
if flush is not None:
614
def emit(self, record):
616
if not isinstance(record.msg, text_type):
617
msg = record.msg.decode("utf-8")
620
line = self.format(record)
621
if not isinstance(line, text_type):
622
line = line.decode("utf-8")
623
self.stream.write(line.encode(self.encoding, self.errors) + b"\n")
625
log_exception_quietly()
626
# Try saving the details that would have been logged in some form
627
msg = args = "<Unformattable>"
629
msg = repr(record.msg)
630
args = repr(record.args)
633
# Using mutter() bypasses the logging module and writes directly
634
# to the file so there's no danger of getting into a loop here.
635
mutter("Logging record unformattable: %s %% %s", msg, args)
638
class Config(object):
639
"""Configuration of message tracing in breezy.
641
This implements the context manager protocol and should manage any global
642
variables still used. The default config used is DefaultConfig, but
643
embedded uses of breezy may wish to use a custom manager.
647
return self # This is bound to the 'as' clause in a with statement.
649
def __exit__(self, exc_type, exc_val, exc_tb):
650
return False # propogate exceptions.
653
class DefaultConfig(Config):
654
"""A default configuration for tracing of messages in breezy.
656
This implements the context manager protocol.
660
self._original_filename = _brz_log_filename
661
self._original_state = enable_default_logging()
662
return self # This is bound to the 'as' clause in a with statement.
664
def __exit__(self, exc_type, exc_val, exc_tb):
665
pop_log_file(self._original_state)
666
global _brz_log_filename
667
_brz_log_filename = self._original_filename
668
return False # propogate exceptions.