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
65
from .lazy_import import lazy_import
64
66
lazy_import(globals(), """
65
from cStringIO import StringIO
73
from bzrlib.symbol_versioning import (
78
74
lazy_import(globals(), """
90
# global verbosity for bzrlib; controls the log level for stderr; 0=normal; <0
91
# global verbosity for breezy; controls the log level for stderr; 0=normal; <0
91
92
# is quiet; >0 is verbose.
92
93
_verbosity_level = 0
97
98
# than push/pop_log_file.
100
# Absolute path for ~/.bzr.log. Not changed even if the log/trace output is
101
# Absolute path for ~/.brz.log. Not changed even if the log/trace output is
101
102
# redirected elsewhere. Used to show the location in --version.
102
_bzr_log_filename = None
103
_brz_log_filename = None
104
105
# The time the first message was written to the trace file, so that we can
105
106
# show relative times since startup.
106
_bzr_log_start_time = bzrlib._start_time
107
_brz_log_start_time = breezy._start_time
109
110
# held in a global for quick reference
110
_bzr_logger = logging.getLogger('bzr')
111
_brz_logger = logging.getLogger('brz')
113
114
def note(*args, **kwargs):
114
115
"""Output a note to the user.
116
117
Takes the same parameters as logging.info.
119
# FIXME note always emits utf-8, regardless of the terminal encoding
121
121
# FIXME: clearing the ui and then going through the abstract logging
122
122
# framework is whack; we should probably have a logging Handler that
123
123
# deals with terminal output if needed.
125
bzrlib.ui.ui_factory.clear_term()
126
_bzr_logger.info(*args, **kwargs)
124
ui.ui_factory.clear_term()
125
_brz_logger.info(*args, **kwargs)
129
128
def warning(*args, **kwargs):
131
bzrlib.ui.ui_factory.clear_term()
132
_bzr_logger.warning(*args, **kwargs)
135
@deprecated_function(deprecated_in((2, 1, 0)))
136
def info(*args, **kwargs):
137
"""Deprecated: use trace.note instead."""
138
note(*args, **kwargs)
141
@deprecated_function(deprecated_in((2, 1, 0)))
142
def log_error(*args, **kwargs):
143
"""Deprecated: use bzrlib.trace.show_error instead"""
144
_bzr_logger.error(*args, **kwargs)
147
@deprecated_function(deprecated_in((2, 1, 0)))
148
def error(*args, **kwargs):
149
"""Deprecated: use bzrlib.trace.show_error instead"""
150
_bzr_logger.error(*args, **kwargs)
129
ui.ui_factory.clear_term()
130
_brz_logger.warning(*args, **kwargs)
153
133
def show_error(*args, **kwargs):
175
155
# is a unicode string
178
if isinstance(arg, unicode):
158
if isinstance(arg, text_type):
179
159
arg = arg.encode('utf8')
180
160
real_args.append(arg)
181
161
out = fmt % tuple(real_args)
184
164
now = time.time()
185
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
186
out = timestamp + out + '\n'
165
out = b'%0.3f %s\n' % (now - _brz_log_start_time, out)
187
166
_trace_file.write(out)
188
167
# there's no explicit flushing; the file is typically line buffered.
222
def _get_bzr_log_filename():
223
bzr_log = os.environ.get('BZR_LOG')
226
home = os.environ.get('BZR_HOME')
201
def _get_brz_log_filename():
202
brz_log = osutils.path_from_environ('BRZ_LOG')
205
home = osutils.path_from_environ('BRZ_HOME')
228
if sys.platform == 'win32':
229
from bzrlib import win32utils
230
home = win32utils.get_home_location()
232
home = os.path.expanduser('~')
233
return os.path.join(home, '.bzr.log')
237
"""Open the .bzr.log trace file.
207
# GZ 2012-02-01: Logging to the home dir is bad, but XDG is unclear
208
# over what would be better. On windows, bug 240550
209
# suggests LOCALAPPDATA be used instead.
210
home = osutils._get_home_dir()
211
return os.path.join(home, '.brz.log')
215
"""Open the .brz.log trace file.
239
217
If the log is more than a particular length, the old file is renamed to
240
.bzr.log.old and a new file is started. Otherwise, we append to the
218
.brz.log.old and a new file is started. Otherwise, we append to the
243
This sets the global _bzr_log_filename.
221
This sets the global _brz_log_filename.
245
global _bzr_log_filename
223
global _brz_log_filename
247
225
def _open_or_create_log_file(filename):
248
226
"""Open existing log file, or create with ownership and permissions
257
235
fd = os.open(filename, flags)
260
238
if e.errno != errno.ENOENT:
263
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
241
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0o666)
265
243
if e.errno != errno.EEXIST:
268
246
osutils.copy_ownership_from_path(filename)
270
return os.fdopen(fd, 'at', 0) # unbuffered
273
_bzr_log_filename = _get_bzr_log_filename()
274
_rollover_trace_maybe(_bzr_log_filename)
248
return os.fdopen(fd, 'ab', 0) # unbuffered
251
_brz_log_filename = _get_brz_log_filename()
252
_rollover_trace_maybe(_brz_log_filename)
276
bzr_log_file = _open_or_create_log_file(_bzr_log_filename)
277
bzr_log_file.write('\n')
278
if bzr_log_file.tell() <= 2:
279
bzr_log_file.write("this is a debug log for diagnosing/reporting problems in bzr\n")
280
bzr_log_file.write("you can delete or truncate this file, or include sections in\n")
281
bzr_log_file.write("bug reports to https://bugs.launchpad.net/bzr/+filebug\n\n")
285
except EnvironmentError, e:
254
brz_log_file = _open_or_create_log_file(_brz_log_filename)
255
brz_log_file.write(b'\n')
256
if brz_log_file.tell() <= 2:
257
brz_log_file.write(b"this is a debug log for diagnosing/reporting problems in brz\n")
258
brz_log_file.write(b"you can delete or truncate this file, or include sections in\n")
259
brz_log_file.write(b"bug reports to https://bugs.launchpad.net/brz/+filebug\n\n")
263
except EnvironmentError as e:
286
264
# If we are failing to open the log, then most likely logging has not
287
265
# been set up yet. So we just write to stderr rather than using
288
266
# 'warning()'. If we using warning(), users get the unhelpful 'no
289
# handlers registered for "bzr"' when something goes wrong on the
267
# handlers registered for "brz"' when something goes wrong on the
290
268
# server. (bug #503886)
291
269
sys.stderr.write("failed to open trace file: %s\n" % (e,))
292
270
# TODO: What should happen if we fail to open the trace file? Maybe the
298
276
def enable_default_logging():
299
"""Configure default logging: messages to stderr and debug to .bzr.log
277
"""Configure default logging: messages to stderr and debug to .brz.log
301
279
This should only be called once per process.
303
Non-command-line programs embedding bzrlib do not need to call this. They
281
Non-command-line programs embedding breezy do not need to call this. They
304
282
can instead either pass a file to _push_log_file, or act directly on
305
logging.getLogger("bzr").
283
logging.getLogger("brz").
307
285
Output can be redirected away by calling _push_log_file.
287
:return: A memento from push_log_file for restoring the log state.
309
# Do this before we open the log file, so we prevent
310
# get_terminal_encoding() from mutter()ing multiple times
311
term_encoding = osutils.get_terminal_encoding()
312
start_time = osutils.format_local_date(_bzr_log_start_time,
289
start_time = osutils.format_local_date(_brz_log_start_time,
313
290
timezone='local')
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
push_log_file(bzr_log_file,
291
brz_log_file = _open_brz_log()
292
if brz_log_file is not None:
293
brz_log_file.write(start_time.encode('utf-8') + b'\n')
294
memento = push_log_file(brz_log_file,
319
295
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
320
296
r'%Y-%m-%d %H:%M:%S')
321
# after hooking output into bzr_log, we also need to attach a stderr
297
# after hooking output into brz_log, we also need to attach a stderr
322
298
# handler, writing only at level info and with encoding
323
writer_factory = codecs.getwriter(term_encoding)
324
encoded_stderr = writer_factory(sys.stderr, errors='replace')
325
stderr_handler = logging.StreamHandler(encoded_stderr)
326
stderr_handler.setLevel(logging.INFO)
327
logging.getLogger('bzr').addHandler(stderr_handler)
299
stderr_handler = EncodedStreamHandler(sys.stderr,
300
osutils.get_terminal_encoding(), 'replace', level=logging.INFO)
301
logging.getLogger('brz').addHandler(stderr_handler)
330
305
def push_log_file(to_file, log_format=None, date_format=None):
333
308
:param to_file: A file-like object to which messages will be sent.
335
310
:returns: A memento that should be passed to _pop_log_file to restore the
336
previously active logging.
311
previously active logging.
338
313
global _trace_file
339
314
# make a new handler
340
new_handler = logging.StreamHandler(to_file)
341
new_handler.setLevel(logging.DEBUG)
315
new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
342
316
if log_format is None:
343
317
log_format = '%(levelname)8s %(message)s'
344
318
new_handler.setFormatter(logging.Formatter(log_format, date_format))
345
319
# save and remove any existing log handlers
346
bzr_logger = logging.getLogger('bzr')
347
old_handlers = bzr_logger.handlers[:]
348
del bzr_logger.handlers[:]
320
brz_logger = logging.getLogger('brz')
321
old_handlers = brz_logger.handlers[:]
322
del brz_logger.handlers[:]
349
323
# set that as the default logger
350
bzr_logger.addHandler(new_handler)
351
bzr_logger.setLevel(logging.DEBUG)
324
brz_logger.addHandler(new_handler)
325
brz_logger.setLevel(logging.DEBUG)
352
326
# TODO: check if any changes are needed to the root logger
354
# TODO: also probably need to save and restore the level on bzr_logger.
328
# TODO: also probably need to save and restore the level on brz_logger.
355
329
# but maybe we can avoid setting the logger level altogether, and just set
356
330
# the level on the handler?
363
337
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
366
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
340
def pop_log_file(entry):
367
341
"""Undo changes to logging/tracing done by _push_log_file.
369
This flushes, but does not close the trace file.
343
This flushes, but does not close the trace file (so that anything that was
371
346
Takes the memento returned from _push_log_file."""
347
(magic, old_handlers, new_handler, old_trace_file, new_trace_file) = entry
372
348
global _trace_file
373
349
_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 atexit, and the
350
brz_logger = logging.getLogger('brz')
351
brz_logger.removeHandler(new_handler)
352
# must be closed, otherwise logging will try to close it at exit, and the
377
353
# file will likely already be closed underneath.
378
354
new_handler.close()
379
bzr_logger.handlers = old_handlers
380
new_trace_file.flush()
355
brz_logger.handlers = old_handlers
356
if new_trace_file is not None:
357
new_trace_file.flush()
383
360
def log_exception_quietly():
437
414
def debug_memory(message='', short=True):
438
415
"""Write out a memory dump."""
439
416
if sys.platform == 'win32':
440
from bzrlib import win32utils
417
from breezy import win32utils
441
418
win32utils.debug_memory_win32api(message=message, short=short)
443
420
_debug_memory_proc(message=message, short=short)
445
def _dump_memory_usage(err_file):
448
fd, name = tempfile.mkstemp(prefix="brz_memdump", suffix=".json")
449
dump_file = os.fdopen(fd, 'w')
450
from meliae import scanner
451
scanner.dump_gc_objects(dump_file)
452
err_file.write("Memory dumped to %s\n" % name)
454
err_file.write("Dumping memory requires meliae module.\n")
455
log_exception_quietly()
457
err_file.write("Exception while dumping memory.\n")
458
log_exception_quietly()
460
if dump_file is not None:
466
def _qualified_exception_name(eclass, unqualified_breezy_errors=False):
467
"""Give name of error class including module for non-builtin exceptions
469
If `unqualified_breezy_errors` is True, errors specific to breezy will
470
also omit the module prefix.
472
class_name = eclass.__name__
473
module_name = eclass.__module__
474
if module_name in ("builtins", "exceptions", "__main__") or (
475
unqualified_breezy_errors and module_name == "breezy.errors"):
477
return "%s.%s" % (module_name, class_name)
469
480
def report_exception(exc_info, err_file):
470
"""Report an exception to err_file (typically stderr) and to .bzr.log.
481
"""Report an exception to err_file (typically stderr) and to .brz.log.
472
483
This will show either a full traceback or a short message as appropriate.
474
485
:return: The appropriate exit code for this error.
476
# Log the full traceback to ~/.bzr.log
487
# Log the full traceback to ~/.brz.log
477
488
log_exception_quietly()
478
489
if 'error' in debug.debug_flags:
479
490
print_exception(exc_info, err_file)
480
491
return errors.EXIT_ERROR
481
492
exc_type, exc_object, exc_tb = exc_info
482
if (isinstance(exc_object, IOError)
483
and getattr(exc_object, 'errno', None) == errno.EPIPE):
484
err_file.write("bzr: broken pipe\n")
485
return errors.EXIT_ERROR
486
elif isinstance(exc_object, KeyboardInterrupt):
487
err_file.write("bzr: interrupted\n")
493
if isinstance(exc_object, KeyboardInterrupt):
494
err_file.write("brz: interrupted\n")
488
495
return errors.EXIT_ERROR
489
496
elif isinstance(exc_object, MemoryError):
490
err_file.write("bzr: out of memory\n")
497
err_file.write("brz: out of memory\n")
498
if 'mem_dump' in debug.debug_flags:
499
_dump_memory_usage(err_file)
501
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
491
502
return errors.EXIT_ERROR
492
503
elif isinstance(exc_object, ImportError) \
493
504
and str(exc_object).startswith("No module named "):
497
508
elif not getattr(exc_object, 'internal_error', True):
498
509
report_user_error(exc_info, err_file)
499
510
return errors.EXIT_ERROR
500
elif isinstance(exc_object, (OSError, IOError)):
511
elif osutils.is_environment_error(exc_object):
512
if getattr(exc_object, 'errno', None) == errno.EPIPE:
513
err_file.write("brz: broken pipe\n")
514
return errors.EXIT_ERROR
501
515
# Might be nice to catch all of these and show them as something more
502
516
# specific, but there are too many cases at the moment.
503
517
report_user_error(exc_info, err_file)
510
524
def print_exception(exc_info, err_file):
511
525
exc_type, exc_object, exc_tb = exc_info
512
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
513
exc_type.__module__, exc_type.__name__, exc_object))
526
err_file.write("brz: ERROR: %s: %s\n" % (
527
_qualified_exception_name(exc_type), exc_object))
514
528
err_file.write('\n')
515
529
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
525
539
:param advice: Extra advice to the user to be printed following the
528
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
542
err_file.write("brz: ERROR: %s\n" % (exc_info[1],))
530
err_file.write("%s\n" % (advice,))
544
err_file.write("%s\n" % advice)
533
547
def report_bug(exc_info, err_file):
534
"""Report an exception that probably indicates a bug in bzr"""
535
from bzrlib.crash import report_bug
548
"""Report an exception that probably indicates a bug in brz"""
549
from breezy.crash import report_bug
536
550
report_bug(exc_info, err_file)
539
553
def _flush_stdout_stderr():
540
# installed into an atexit hook by bzrlib.initialize()
554
# called from the breezy library finalizer returned by breezy.initialize()
542
556
sys.stdout.flush()
543
557
sys.stderr.flush()
558
except ValueError as e:
559
# On Windows, I get ValueError calling stdout.flush() on a closed
546
564
if e.errno in [errno.EINVAL, errno.EPIPE]:
552
570
def _flush_trace():
553
# run from atexit hook
571
# called from the breezy library finalizer returned by breezy.initialize()
554
572
global _trace_file
556
574
_trace_file.flush()
577
class EncodedStreamHandler(logging.Handler):
578
"""Robustly write logging events to a stream using the specified encoding
580
Messages are expected to be formatted to unicode, but UTF-8 byte strings
581
are also accepted. An error during formatting or a str message in another
582
encoding will be quitely noted as an error in the Bazaar log file.
584
The stream is not closed so sys.stdout or sys.stderr may be passed.
587
def __init__(self, stream, encoding=None, errors='strict', level=0):
588
logging.Handler.__init__(self, level)
591
encoding = getattr(stream, "encoding", "ascii")
592
self.encoding = encoding
596
flush = getattr(self.stream, "flush", None)
597
if flush is not None:
600
def emit(self, record):
602
if not isinstance(record.msg, text_type):
603
msg = record.msg.decode("utf-8")
606
line = self.format(record)
607
if not isinstance(line, text_type):
608
line = line.decode("utf-8")
609
self.stream.write(line.encode(self.encoding, self.errors) + b"\n")
611
log_exception_quietly()
612
# Try saving the details that would have been logged in some form
613
msg = args = "<Unformattable>"
615
msg = repr(record.msg).encode("ascii", "backslashescape")
616
args = repr(record.args).encode("ascii", "backslashescape")
619
# Using mutter() bypasses the logging module and writes directly
620
# to the file so there's no danger of getting into a loop here.
621
mutter("Logging record unformattable: %s %% %s", msg, args)
624
class Config(object):
625
"""Configuration of message tracing in breezy.
627
This implements the context manager protocol and should manage any global
628
variables still used. The default config used is DefaultConfig, but
629
embedded uses of breezy may wish to use a custom manager.
633
return self # This is bound to the 'as' clause in a with statement.
635
def __exit__(self, exc_type, exc_val, exc_tb):
636
return False # propogate exceptions.
639
class DefaultConfig(Config):
640
"""A default configuration for tracing of messages in breezy.
642
This implements the context manager protocol.
646
self._original_filename = _brz_log_filename
647
self._original_state = enable_default_logging()
648
return self # This is bound to the 'as' clause in a with statement.
650
def __exit__(self, exc_type, exc_val, exc_tb):
651
pop_log_file(self._original_state)
652
global _brz_log_filename
653
_brz_log_filename = self._original_filename
654
return False # propogate exceptions.
added
removed
breezy/trace.py
