1
# Copyright (C) 2005-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Messages and logging.
19
Messages are supplied by callers as a string-formatting template, plus values
20
to be inserted into it. The actual %-formatting is deferred to the log
21
library so that it doesn't need to be done for messages that won't be emitted.
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.
30
`brz.log` gets all messages, and full tracebacks for uncaught exceptions.
31
This trace file is always in UTF-8, regardless of the user's default encoding,
32
so that we can always rely on writing any message.
34
Output to stderr depends on the mode chosen by the user. By default, messages
35
of info and above are sent out, which results in progress messages such as the
36
list of files processed by add and commit. In debug mode, stderr gets debug messages too.
38
Errors that terminate an operation are generally passed back as exceptions;
39
others may be just emitted as messages.
41
Exceptions are reported in a brief form to stderr so as not to look scary.
42
BzrErrors are required to be able to format themselves into a properly
43
explanatory message. This is not true for builtin exceptions such as
44
KeyError, which typically just str to "0". They're printed in a different
48
from __future__ import absolute_import
50
# FIXME: Unfortunately it turns out that python's logging module
51
# is quite expensive, even when the message is not printed by any handlers.
52
# We should perhaps change back to just simply doing it here.
54
# On the other hand, as of 1.2 we generally only call the mutter() statement
55
# if (according to debug_flags) we actually intend to write it. So the
56
# increased cost of logging.py is not so bad, and we could standardize on
65
from .lazy_import import lazy_import
66
lazy_import(globals(), """
73
lazy_import(globals(), """
90
# global verbosity for breezy; controls the log level for stderr; 0=normal; <0
91
# is quiet; >0 is verbose.
94
# File-like object where mutter/debug output is currently sent. Can be
95
# changed by _push_log_file etc. This is directly manipulated by some
96
# external code; maybe there should be functions to do that more precisely
97
# than push/pop_log_file.
100
# Absolute path for brz.log. Not changed even if the log/trace output is
101
# redirected elsewhere. Used to show the location in --version.
102
_brz_log_filename = None
104
# The time the first message was written to the trace file, so that we can
105
# show relative times since startup.
106
_brz_log_start_time = breezy._start_time
109
# held in a global for quick reference
110
_brz_logger = logging.getLogger('brz')
113
def note(*args, **kwargs):
114
"""Output a note to the user.
116
Takes the same parameters as logging.info.
120
# FIXME: clearing the ui and then going through the abstract logging
121
# framework is whack; we should probably have a logging Handler that
122
# deals with terminal output if needed.
123
ui.ui_factory.clear_term()
124
_brz_logger.info(*args, **kwargs)
127
def warning(*args, **kwargs):
128
ui.ui_factory.clear_term()
129
_brz_logger.warning(*args, **kwargs)
132
def show_error(*args, **kwargs):
133
"""Show an error message to the user.
135
Don't use this for exceptions, use report_exception instead.
137
_brz_logger.error(*args, **kwargs)
141
"""Compat class for displaying bytes on Python 2."""
144
return 'b' + str.__repr__(self)
146
def __unicode__(self):
147
return self.decode('ascii', 'replace')
150
def mutter(fmt, *args):
151
if _trace_file is None:
153
# XXX: Don't check this every time; instead anyone who closes the file
154
# ought to deregister it. We can tolerate None.
155
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')
165
_Bytes(arg) if isinstance(arg, bytes) else arg for arg in args)
170
out = '%0.3f %s\n' % (now - _brz_log_start_time, out)
171
_trace_file.write(out.encode('utf-8'))
172
# there's no explicit flushing; the file is typically line buffered.
175
def mutter_callsite(stacklevel, fmt, *args):
176
"""Perform a mutter of fmt and args, logging the call trace.
178
:param stacklevel: The number of frames to show. None will show all
180
:param fmt: The format string to pass to mutter.
181
:param args: A list of substitution variables.
184
if stacklevel is None:
187
limit = stacklevel + 1
188
traceback.print_stack(limit=limit, file=outf)
189
formatted_lines = outf.getvalue().splitlines()
190
formatted_stack = '\n'.join(formatted_lines[:-2])
191
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
194
def _rollover_trace_maybe(trace_fname):
197
size = os.stat(trace_fname)[stat.ST_SIZE]
200
old_fname = trace_fname + '.old'
201
osutils.rename(trace_fname, old_fname)
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.
221
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
225
This sets the global _brz_log_filename.
227
global _brz_log_filename
229
def _open_or_create_log_file(filename):
230
"""Open existing log file, or create with ownership and permissions
232
It inherits the ownership and permissions (masked by umask) from
233
the containing directory to cope better with being run under sudo
234
with $HOME still set to the user's homedir.
236
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
239
fd = os.open(filename, flags)
242
if e.errno != errno.ENOENT:
245
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0o666)
247
if e.errno != errno.EEXIST:
250
osutils.copy_ownership_from_path(filename)
252
return os.fdopen(fd, 'ab', 0) # unbuffered
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
# If we are failing to open the log, then most likely logging has not
272
# been set up yet. So we just write to stderr rather than using
273
# 'warning()'. If we using warning(), users get the unhelpful 'no
274
# handlers registered for "brz"' when something goes wrong on the
275
# server. (bug #503886)
276
sys.stderr.write("failed to open trace file: %s\n" % (e,))
277
# TODO: What should happen if we fail to open the trace file? Maybe the
278
# objects should be pointed at /dev/null or the equivalent? Currently
279
# returns None which will cause failures later.
283
def enable_default_logging():
284
"""Configure default logging: messages to stderr and debug to brz.log
286
This should only be called once per process.
288
Non-command-line programs embedding breezy do not need to call this. They
289
can instead either pass a file to _push_log_file, or act directly on
290
logging.getLogger("brz").
292
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,
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(
303
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
304
r'%Y-%m-%d %H:%M:%S')
305
# after hooking output into brz_log, we also need to attach a stderr
306
# 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)
317
def push_log_file(to_file, log_format=None, date_format=None):
318
"""Intercept log and trace messages and send them to a file.
320
:param to_file: A file-like object to which messages will be sent.
322
:returns: A memento that should be passed to _pop_log_file to restore the
323
previously active logging.
327
new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
328
if log_format is None:
329
log_format = '%(levelname)8s %(message)s'
330
new_handler.setFormatter(logging.Formatter(log_format, date_format))
331
# save and remove any existing log handlers
332
brz_logger = logging.getLogger('brz')
333
old_handlers = brz_logger.handlers[:]
334
del brz_logger.handlers[:]
335
# set that as the default logger
336
brz_logger.addHandler(new_handler)
337
brz_logger.setLevel(logging.DEBUG)
338
# 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.
341
# but maybe we can avoid setting the logger level altogether, and just set
342
# the level on the handler?
344
# save the old trace file
345
old_trace_file = _trace_file
346
# send traces to the new one
347
_trace_file = to_file
348
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
351
def pop_log_file(entry):
352
"""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
357
Takes the memento returned from _push_log_file."""
358
(magic, old_handlers, new_handler, old_trace_file, new_trace_file) = entry
360
_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
364
# file will likely already be closed underneath.
366
brz_logger.handlers = old_handlers
367
if new_trace_file is not None:
368
new_trace_file.flush()
371
def log_exception_quietly():
372
"""Log the last exception to the trace file only.
374
Used for exceptions that occur internally and that may be
375
interesting to developers but not to users. For example,
376
errors loading plugins.
378
mutter(traceback.format_exc())
381
def set_verbosity_level(level):
382
"""Set the verbosity level.
384
:param level: -ve for quiet, 0 for normal, +ve for verbose
386
global _verbosity_level
387
_verbosity_level = level
388
_update_logging_level(level < 0)
389
ui.ui_factory.be_quiet(level < 0)
392
def get_verbosity_level():
393
"""Get the verbosity level.
395
See set_verbosity_level() for values.
397
return _verbosity_level
400
def be_quiet(quiet=True):
402
set_verbosity_level(-1)
404
set_verbosity_level(0)
407
def _update_logging_level(quiet=True):
408
"""Hide INFO messages if quiet."""
410
_brz_logger.setLevel(logging.WARNING)
412
_brz_logger.setLevel(logging.INFO)
416
"""Is the verbosity level negative?"""
417
return _verbosity_level < 0
421
"""Is the verbosity level positive?"""
422
return _verbosity_level > 0
425
def debug_memory(message='', short=True):
426
"""Write out a memory dump."""
427
if sys.platform == 'win32':
428
from breezy import win32utils
429
win32utils.debug_memory_win32api(message=message, short=short)
431
_debug_memory_proc(message=message, short=short)
434
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
437
def _debug_memory_proc(message='', short=True):
439
status_file = open('/proc/%s/status' % os.getpid(), 'rb')
443
status = status_file.read()
448
for line in status.splitlines():
452
for field in _short_fields:
453
if line.startswith(field):
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
def report_exception(exc_info, err_file):
494
"""Report an exception to err_file (typically stderr) and to brz.log.
496
This will show either a full traceback or a short message as appropriate.
498
:return: The appropriate exit code for this error.
500
# Log the full traceback to brz.log
501
log_exception_quietly()
502
if 'error' in debug.debug_flags:
503
print_exception(exc_info, err_file)
504
return errors.EXIT_ERROR
505
exc_type, exc_object, exc_tb = exc_info
506
if isinstance(exc_object, KeyboardInterrupt):
507
err_file.write("brz: interrupted\n")
508
return errors.EXIT_ERROR
509
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")
515
return errors.EXIT_ERROR
516
elif isinstance(exc_object, ImportError) \
517
and str(exc_object).startswith("No module named "):
520
'You may need to install this Python library separately.')
521
return errors.EXIT_ERROR
522
elif not getattr(exc_object, 'internal_error', True):
523
report_user_error(exc_info, err_file)
524
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
529
# Might be nice to catch all of these and show them as something more
530
# specific, but there are too many cases at the moment.
531
report_user_error(exc_info, err_file)
532
return errors.EXIT_ERROR
534
report_bug(exc_info, err_file)
535
return errors.EXIT_INTERNAL_ERROR
538
def print_exception(exc_info, err_file):
539
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))
543
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
546
# TODO: Should these be specially encoding the output?
547
def report_user_error(exc_info, err_file, advice=None):
548
"""Report to err_file an error that's not an internal error.
550
These don't get a traceback unless -Derror was given.
552
:param exc_info: 3-tuple from sys.exc_info()
553
:param advice: Extra advice to the user to be printed following the
556
err_file.write(("brz: ERROR: %s\n" % (str(exc_info[1]),)))
558
err_file.write(("%s\n" % advice))
561
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
564
report_bug(exc_info, err_file)
567
def _flush_stdout_stderr():
568
# called from the breezy library finalizer returned by breezy.initialize()
573
# On Windows, I get ValueError calling stdout.flush() on a closed
578
if e.errno in [errno.EINVAL, errno.EPIPE]:
585
# called from the breezy library finalizer returned by breezy.initialize()
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.
added
removed
breezy/trace.py
