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
89
# global verbosity for breezy; controls the log level for stderr; 0=normal; <0
91
90
# is quiet; >0 is verbose.
92
91
_verbosity_level = 0
97
96
# than push/pop_log_file.
100
# Absolute path for ~/.bzr.log. Not changed even if the log/trace output is
99
# Absolute path for ~/.brz.log. Not changed even if the log/trace output is
101
100
# redirected elsewhere. Used to show the location in --version.
102
_bzr_log_filename = None
101
_brz_log_filename = None
104
103
# The time the first message was written to the trace file, so that we can
105
104
# show relative times since startup.
106
_bzr_log_start_time = bzrlib._start_time
105
_brz_log_start_time = breezy._start_time
109
108
# held in a global for quick reference
110
_bzr_logger = logging.getLogger('bzr')
109
_brz_logger = logging.getLogger('brz')
113
112
def note(*args, **kwargs):
114
# FIXME note always emits utf-8, regardless of the terminal encoding
113
"""Output a note to the user.
115
Takes the same parameters as logging.info.
116
119
# FIXME: clearing the ui and then going through the abstract logging
117
120
# framework is whack; we should probably have a logging Handler that
118
121
# deals with terminal output if needed.
120
bzrlib.ui.ui_factory.clear_term()
121
_bzr_logger.info(*args, **kwargs)
122
ui.ui_factory.clear_term()
123
_brz_logger.info(*args, **kwargs)
124
126
def 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)
127
ui.ui_factory.clear_term()
128
_brz_logger.warning(*args, **kwargs)
148
131
def show_error(*args, **kwargs):
170
153
# is a unicode string
173
if isinstance(arg, unicode):
156
if isinstance(arg, text_type):
174
157
arg = arg.encode('utf8')
175
158
real_args.append(arg)
176
159
out = fmt % tuple(real_args)
179
162
now = time.time()
180
timestamp = '%0.3f ' % (now - _bzr_log_start_time,)
181
out = timestamp + out + '\n'
163
out = b'%0.3f %s\n' % (now - _brz_log_start_time, out)
182
164
_trace_file.write(out)
183
165
# there's no explicit flushing; the file is typically line buffered.
217
def _get_bzr_log_filename():
218
bzr_log = os.environ.get('BZR_LOG')
221
home = os.environ.get('BZR_HOME')
199
def _get_brz_log_filename():
200
brz_log = osutils.path_from_environ('BRZ_LOG')
203
home = osutils.path_from_environ('BRZ_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.
205
# GZ 2012-02-01: Logging to the home dir is bad, but XDG is unclear
206
# over what would be better. On windows, bug 240550
207
# suggests LOCALAPPDATA be used instead.
208
home = osutils._get_home_dir()
209
return os.path.join(home, '.brz.log')
213
"""Open the .brz.log trace file.
234
215
If the log is more than a particular length, the old file is renamed to
235
.bzr.log.old and a new file is started. Otherwise, we append to the
216
.brz.log.old and a new file is started. Otherwise, we append to the
238
This sets the global _bzr_log_filename.
219
This sets the global _brz_log_filename.
240
global _bzr_log_filename
221
global _brz_log_filename
242
223
def _open_or_create_log_file(filename):
243
224
"""Open existing log file, or create with ownership and permissions
252
233
fd = os.open(filename, flags)
255
236
if e.errno != errno.ENOENT:
258
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0666)
239
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0o666)
260
241
if e.errno != errno.EEXIST:
263
244
osutils.copy_ownership_from_path(filename)
265
return os.fdopen(fd, 'at', 0) # unbuffered
268
_bzr_log_filename = _get_bzr_log_filename()
269
_rollover_trace_maybe(_bzr_log_filename)
246
return os.fdopen(fd, 'ab', 0) # unbuffered
249
_brz_log_filename = _get_brz_log_filename()
250
_rollover_trace_maybe(_brz_log_filename)
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:
252
brz_log_file = _open_or_create_log_file(_brz_log_filename)
253
brz_log_file.write(b'\n')
254
if brz_log_file.tell() <= 2:
255
brz_log_file.write("this is a debug log for diagnosing/reporting problems in brz\n")
256
brz_log_file.write("you can delete or truncate this file, or include sections in\n")
257
brz_log_file.write("bug reports to https://bugs.launchpad.net/brz/+filebug\n\n")
261
except EnvironmentError as e:
281
262
# If we are failing to open the log, then most likely logging has not
282
263
# been set up yet. So we just write to stderr rather than using
283
264
# 'warning()'. If we using warning(), users get the unhelpful 'no
284
# handlers registered for "bzr"' when something goes wrong on the
265
# handlers registered for "brz"' when something goes wrong on the
285
266
# server. (bug #503886)
286
267
sys.stderr.write("failed to open trace file: %s\n" % (e,))
287
268
# TODO: What should happen if we fail to open the trace file? Maybe the
293
274
def enable_default_logging():
294
"""Configure default logging: messages to stderr and debug to .bzr.log
275
"""Configure default logging: messages to stderr and debug to .brz.log
296
277
This should only be called once per process.
298
Non-command-line programs embedding bzrlib do not need to call this. They
279
Non-command-line programs embedding breezy do not need to call this. They
299
280
can instead either pass a file to _push_log_file, or act directly on
300
logging.getLogger("bzr").
281
logging.getLogger("brz").
302
283
Output can be redirected away by calling _push_log_file.
285
:return: A memento from push_log_file for restoring the log state.
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,
287
start_time = osutils.format_local_date(_brz_log_start_time,
308
288
timezone='local')
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,
289
brz_log_file = _open_brz_log()
290
if brz_log_file is not None:
291
brz_log_file.write(start_time.encode('utf-8') + b'\n')
292
memento = push_log_file(brz_log_file,
314
293
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
315
294
r'%Y-%m-%d %H:%M:%S')
316
# after hooking output into bzr_log, we also need to attach a stderr
295
# after hooking output into brz_log, we also need to attach a stderr
317
296
# handler, writing only at level info and with encoding
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)
297
stderr_handler = EncodedStreamHandler(sys.stderr,
298
osutils.get_terminal_encoding(), 'replace', level=logging.INFO)
299
logging.getLogger('brz').addHandler(stderr_handler)
325
303
def push_log_file(to_file, log_format=None, date_format=None):
328
306
:param to_file: A file-like object to which messages will be sent.
330
308
:returns: A memento that should be passed to _pop_log_file to restore the
331
previously active logging.
309
previously active logging.
333
311
global _trace_file
334
312
# make a new handler
335
new_handler = logging.StreamHandler(to_file)
336
new_handler.setLevel(logging.DEBUG)
313
new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
337
314
if log_format is None:
338
315
log_format = '%(levelname)8s %(message)s'
339
316
new_handler.setFormatter(logging.Formatter(log_format, date_format))
340
317
# save and remove any existing log handlers
341
bzr_logger = logging.getLogger('bzr')
342
old_handlers = bzr_logger.handlers[:]
343
del bzr_logger.handlers[:]
318
brz_logger = logging.getLogger('brz')
319
old_handlers = brz_logger.handlers[:]
320
del brz_logger.handlers[:]
344
321
# set that as the default logger
345
bzr_logger.addHandler(new_handler)
346
bzr_logger.setLevel(logging.DEBUG)
322
brz_logger.addHandler(new_handler)
323
brz_logger.setLevel(logging.DEBUG)
347
324
# TODO: check if any changes are needed to the root logger
349
# TODO: also probably need to save and restore the level on bzr_logger.
326
# TODO: also probably need to save and restore the level on brz_logger.
350
327
# but maybe we can avoid setting the logger level altogether, and just set
351
328
# the level on the handler?
358
335
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
361
def pop_log_file((magic, old_handlers, new_handler, old_trace_file, new_trace_file)):
338
def pop_log_file(entry):
362
339
"""Undo changes to logging/tracing done by _push_log_file.
364
This flushes, but does not close the trace file.
341
This flushes, but does not close the trace file (so that anything that was
366
344
Takes the memento returned from _push_log_file."""
345
(magic, old_handlers, new_handler, old_trace_file, new_trace_file) = entry
367
346
global _trace_file
368
347
_trace_file = old_trace_file
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
348
brz_logger = logging.getLogger('brz')
349
brz_logger.removeHandler(new_handler)
350
# must be closed, otherwise logging will try to close it at exit, and the
372
351
# file will likely already be closed underneath.
373
352
new_handler.close()
374
bzr_logger.handlers = old_handlers
375
new_trace_file.flush()
353
brz_logger.handlers = old_handlers
354
if new_trace_file is not None:
355
new_trace_file.flush()
378
358
def log_exception_quietly():
432
412
def debug_memory(message='', short=True):
433
413
"""Write out a memory dump."""
434
414
if sys.platform == 'win32':
435
from bzrlib import win32utils
415
from breezy import win32utils
436
416
win32utils.debug_memory_win32api(message=message, short=short)
438
418
_debug_memory_proc(message=message, short=short)
443
def _dump_memory_usage(err_file):
446
fd, name = tempfile.mkstemp(prefix="brz_memdump", suffix=".json")
447
dump_file = os.fdopen(fd, 'w')
448
from meliae import scanner
449
scanner.dump_gc_objects(dump_file)
450
err_file.write("Memory dumped to %s\n" % name)
452
err_file.write("Dumping memory requires meliae module.\n")
453
log_exception_quietly()
455
err_file.write("Exception while dumping memory.\n")
456
log_exception_quietly()
458
if dump_file is not None:
464
def _qualified_exception_name(eclass, unqualified_breezy_errors=False):
465
"""Give name of error class including module for non-builtin exceptions
467
If `unqualified_breezy_errors` is True, errors specific to breezy will
468
also omit the module prefix.
470
class_name = eclass.__name__
471
module_name = eclass.__module__
472
if module_name in ("exceptions", "__main__") or (
473
unqualified_breezy_errors and module_name == "breezy.errors"):
475
return "%s.%s" % (module_name, class_name)
464
478
def report_exception(exc_info, err_file):
465
"""Report an exception to err_file (typically stderr) and to .bzr.log.
479
"""Report an exception to err_file (typically stderr) and to .brz.log.
467
481
This will show either a full traceback or a short message as appropriate.
469
483
:return: The appropriate exit code for this error.
471
# Log the full traceback to ~/.bzr.log
485
# Log the full traceback to ~/.brz.log
472
486
log_exception_quietly()
473
487
if 'error' in debug.debug_flags:
474
488
print_exception(exc_info, err_file)
475
489
return errors.EXIT_ERROR
476
490
exc_type, exc_object, exc_tb = exc_info
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")
491
if isinstance(exc_object, KeyboardInterrupt):
492
err_file.write("brz: interrupted\n")
483
493
return errors.EXIT_ERROR
484
494
elif isinstance(exc_object, MemoryError):
485
err_file.write("bzr: out of memory\n")
495
err_file.write("brz: out of memory\n")
496
if 'mem_dump' in debug.debug_flags:
497
_dump_memory_usage(err_file)
499
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
486
500
return errors.EXIT_ERROR
487
501
elif isinstance(exc_object, ImportError) \
488
502
and str(exc_object).startswith("No module named "):
492
506
elif not getattr(exc_object, 'internal_error', True):
493
507
report_user_error(exc_info, err_file)
494
508
return errors.EXIT_ERROR
495
elif isinstance(exc_object, (OSError, IOError)):
509
elif osutils.is_environment_error(exc_object):
510
if getattr(exc_object, 'errno', None) == errno.EPIPE:
511
err_file.write("brz: broken pipe\n")
512
return errors.EXIT_ERROR
496
513
# Might be nice to catch all of these and show them as something more
497
514
# specific, but there are too many cases at the moment.
498
515
report_user_error(exc_info, err_file)
505
522
def print_exception(exc_info, err_file):
506
523
exc_type, exc_object, exc_tb = exc_info
507
err_file.write("bzr: ERROR: %s.%s: %s\n" % (
524
err_file.write("brz: ERROR: %s.%s: %s\n" % (
508
525
exc_type.__module__, exc_type.__name__, exc_object))
509
526
err_file.write('\n')
510
527
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
520
537
:param advice: Extra advice to the user to be printed following the
523
err_file.write("bzr: ERROR: %s\n" % (exc_info[1],))
540
err_file.write("brz: ERROR: %s\n" % (exc_info[1],))
525
542
err_file.write("%s\n" % (advice,))
528
545
def report_bug(exc_info, err_file):
529
"""Report an exception that probably indicates a bug in bzr"""
530
from bzrlib.crash import report_bug
546
"""Report an exception that probably indicates a bug in brz"""
547
from breezy.crash import report_bug
531
548
report_bug(exc_info, err_file)
534
551
def _flush_stdout_stderr():
535
# installed into an atexit hook by bzrlib.initialize()
552
# called from the breezy library finalizer returned by breezy.initialize()
537
554
sys.stdout.flush()
538
555
sys.stderr.flush()
556
except ValueError as e:
557
# On Windows, I get ValueError calling stdout.flush() on a closed
541
562
if e.errno in [errno.EINVAL, errno.EPIPE]:
547
568
def _flush_trace():
548
# run from atexit hook
569
# called from the breezy library finalizer returned by breezy.initialize()
549
570
global _trace_file
551
572
_trace_file.flush()
575
class EncodedStreamHandler(logging.Handler):
576
"""Robustly write logging events to a stream using the specified encoding
578
Messages are expected to be formatted to unicode, but UTF-8 byte strings
579
are also accepted. An error during formatting or a str message in another
580
encoding will be quitely noted as an error in the Bazaar log file.
582
The stream is not closed so sys.stdout or sys.stderr may be passed.
585
def __init__(self, stream, encoding=None, errors='strict', level=0):
586
logging.Handler.__init__(self, level)
589
encoding = getattr(stream, "encoding", "ascii")
590
self.encoding = encoding
594
flush = getattr(self.stream, "flush", None)
595
if flush is not None:
598
def emit(self, record):
600
line = self.format(record)
601
if not isinstance(line, text_type):
602
line = line.decode("utf-8")
603
self.stream.write(line.encode(self.encoding, self.errors) + b"\n")
605
log_exception_quietly()
606
# Try saving the details that would have been logged in some form
607
msg = args = "<Unformattable>"
609
msg = repr(record.msg).encode("ascii")
610
args = repr(record.args).encode("ascii")
613
# Using mutter() bypasses the logging module and writes directly
614
# to the file so there's no danger of getting into a loop here.
615
mutter("Logging record unformattable: %s %% %s", msg, args)
618
class Config(object):
619
"""Configuration of message tracing in breezy.
621
This implements the context manager protocol and should manage any global
622
variables still used. The default config used is DefaultConfig, but
623
embedded uses of breezy may wish to use a custom manager.
627
return self # This is bound to the 'as' clause in a with statement.
629
def __exit__(self, exc_type, exc_val, exc_tb):
630
return False # propogate exceptions.
633
class DefaultConfig(Config):
634
"""A default configuration for tracing of messages in breezy.
636
This implements the context manager protocol.
640
self._original_filename = _brz_log_filename
641
self._original_state = enable_default_logging()
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
pop_log_file(self._original_state)
646
global _brz_log_filename
647
_brz_log_filename = self._original_filename
648
return False # propogate exceptions.
added
removed
breezy/trace.py
