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):
120
# FIXME note always emits utf-8, regardless of the terminal encoding
122
121
# FIXME: clearing the ui and then going through the abstract logging
123
122
# framework is whack; we should probably have a logging Handler that
124
123
# deals with terminal output if needed.
126
bzrlib.ui.ui_factory.clear_term()
127
_bzr_logger.info(*args, **kwargs)
124
ui.ui_factory.clear_term()
125
_brz_logger.info(*args, **kwargs)
130
128
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)
129
ui.ui_factory.clear_term()
130
_brz_logger.warning(*args, **kwargs)
154
133
def show_error(*args, **kwargs):
176
155
# is a unicode string
179
if isinstance(arg, unicode):
158
if isinstance(arg, text_type):
180
159
arg = arg.encode('utf8')
181
160
real_args.append(arg)
182
161
out = fmt % tuple(real_args)
185
164
now = time.time()
186
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
187
out = timestamp + out + '\n'
165
out = b'%0.3f %s\n' % (now - _brz_log_start_time, out)
188
166
_trace_file.write(out)
189
167
# there's no explicit flushing; the file is typically line buffered.
223
def _get_bzr_log_filename():
224
bzr_log = os.environ.get('BZR_LOG')
227
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')
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.
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.
240
217
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
218
.brz.log.old and a new file is started. Otherwise, we append to the
244
This sets the global _bzr_log_filename.
221
This sets the global _brz_log_filename.
246
global _bzr_log_filename
223
global _brz_log_filename
248
225
def _open_or_create_log_file(filename):
249
226
"""Open existing log file, or create with ownership and permissions
258
235
fd = os.open(filename, flags)
261
238
if e.errno != errno.ENOENT:
264
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)
266
243
if e.errno != errno.EEXIST:
269
246
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)
248
return os.fdopen(fd, 'ab', 0) # unbuffered
251
_brz_log_filename = _get_brz_log_filename()
252
_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")
286
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:
287
264
# If we are failing to open the log, then most likely logging has not
288
265
# been set up yet. So we just write to stderr rather than using
289
266
# 'warning()'. If we using warning(), users get the unhelpful 'no
290
# handlers registered for "bzr"' when something goes wrong on the
267
# handlers registered for "brz"' when something goes wrong on the
291
268
# server. (bug #503886)
292
269
sys.stderr.write("failed to open trace file: %s\n" % (e,))
293
270
# TODO: What should happen if we fail to open the trace file? Maybe the
299
276
def enable_default_logging():
300
"""Configure default logging: messages to stderr and debug to .bzr.log
277
"""Configure default logging: messages to stderr and debug to .brz.log
302
279
This should only be called once per process.
304
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
305
282
can instead either pass a file to _push_log_file, or act directly on
306
logging.getLogger("bzr").
283
logging.getLogger("brz").
308
285
Output can be redirected away by calling _push_log_file.
287
: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,
289
start_time = osutils.format_local_date(_brz_log_start_time,
314
290
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,
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,
320
295
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
321
296
r'%Y-%m-%d %H:%M:%S')
322
# 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
323
298
# 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)
299
stderr_handler = EncodedStreamHandler(sys.stderr,
300
osutils.get_terminal_encoding(), 'replace', level=logging.INFO)
301
logging.getLogger('brz').addHandler(stderr_handler)
331
305
def push_log_file(to_file, log_format=None, date_format=None):
334
308
:param to_file: A file-like object to which messages will be sent.
336
310
:returns: A memento that should be passed to _pop_log_file to restore the
337
previously active logging.
311
previously active logging.
339
313
global _trace_file
340
314
# make a new handler
341
new_handler = logging.StreamHandler(to_file)
342
new_handler.setLevel(logging.DEBUG)
315
new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
343
316
if log_format is None:
344
317
log_format = '%(levelname)8s %(message)s'
345
318
new_handler.setFormatter(logging.Formatter(log_format, date_format))
346
319
# save and remove any existing log handlers
347
bzr_logger = logging.getLogger('bzr')
348
old_handlers = bzr_logger.handlers[:]
349
del bzr_logger.handlers[:]
320
brz_logger = logging.getLogger('brz')
321
old_handlers = brz_logger.handlers[:]
322
del brz_logger.handlers[:]
350
323
# set that as the default logger
351
bzr_logger.addHandler(new_handler)
352
bzr_logger.setLevel(logging.DEBUG)
324
brz_logger.addHandler(new_handler)
325
brz_logger.setLevel(logging.DEBUG)
353
326
# 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.
328
# TODO: also probably need to save and restore the level on brz_logger.
356
329
# but maybe we can avoid setting the logger level altogether, and just set
357
330
# the level on the handler?
364
337
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
367
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
340
def pop_log_file(entry):
368
341
"""Undo changes to logging/tracing done by _push_log_file.
370
This flushes, but does not close the trace file.
343
This flushes, but does not close the trace file (so that anything that was
372
346
Takes the memento returned from _push_log_file."""
347
(magic, old_handlers, new_handler, old_trace_file, new_trace_file) = entry
373
348
global _trace_file
374
349
_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
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
378
353
# file will likely already be closed underneath.
379
354
new_handler.close()
380
bzr_logger.handlers = old_handlers
381
new_trace_file.flush()
355
brz_logger.handlers = old_handlers
356
if new_trace_file is not None:
357
new_trace_file.flush()
384
360
def log_exception_quietly():
438
414
def debug_memory(message='', short=True):
439
415
"""Write out a memory dump."""
440
416
if sys.platform == 'win32':
441
from bzrlib import win32utils
417
from breezy import win32utils
442
418
win32utils.debug_memory_win32api(message=message, short=short)
444
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)
470
480
def report_exception(exc_info, err_file):
471
"""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.
473
483
This will show either a full traceback or a short message as appropriate.
475
485
:return: The appropriate exit code for this error.
477
# Log the full traceback to ~/.bzr.log
487
# Log the full traceback to ~/.brz.log
478
488
log_exception_quietly()
479
489
if 'error' in debug.debug_flags:
480
490
print_exception(exc_info, err_file)
481
491
return errors.EXIT_ERROR
482
492
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")
493
if isinstance(exc_object, KeyboardInterrupt):
494
err_file.write("brz: interrupted\n")
489
495
return errors.EXIT_ERROR
490
496
elif isinstance(exc_object, MemoryError):
491
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")
492
502
return errors.EXIT_ERROR
493
503
elif isinstance(exc_object, ImportError) \
494
504
and str(exc_object).startswith("No module named "):
498
508
elif not getattr(exc_object, 'internal_error', True):
499
509
report_user_error(exc_info, err_file)
500
510
return errors.EXIT_ERROR
501
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
502
515
# Might be nice to catch all of these and show them as something more
503
516
# specific, but there are too many cases at the moment.
504
517
report_user_error(exc_info, err_file)
511
524
def print_exception(exc_info, err_file):
512
525
exc_type, exc_object, exc_tb = exc_info
513
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
514
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))
515
528
err_file.write('\n')
516
529
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
526
539
:param advice: Extra advice to the user to be printed following the
529
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
542
err_file.write("brz: ERROR: %s\n" % (exc_info[1],))
531
err_file.write("%s\n" % (advice,))
544
err_file.write("%s\n" % advice)
534
547
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
548
"""Report an exception that probably indicates a bug in brz"""
549
from breezy.crash import report_bug
537
550
report_bug(exc_info, err_file)
540
553
def _flush_stdout_stderr():
541
# installed into an atexit hook by bzrlib.initialize()
554
# called from the breezy library finalizer returned by breezy.initialize()
543
556
sys.stdout.flush()
544
557
sys.stderr.flush()
558
except ValueError as e:
559
# On Windows, I get ValueError calling stdout.flush() on a closed
547
564
if e.errno in [errno.EINVAL, errno.EPIPE]:
553
570
def _flush_trace():
554
# run from atexit hook
571
# called from the breezy library finalizer returned by breezy.initialize()
555
572
global _trace_file
557
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
