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(), """
92
# global verbosity for breezy; controls the log level for stderr; 0=normal; <0
93
# is quiet; >0 is verbose.
96
# File-like object where mutter/debug output is currently sent. Can be
97
# changed by _push_log_file etc. This is directly manipulated by some
98
# external code; maybe there should be functions to do that more precisely
99
# than push/pop_log_file.
102
# Absolute path for brz.log. Not changed even if the log/trace output is
103
# redirected elsewhere. Used to show the location in --version.
104
_brz_log_filename = None
106
# The time the first message was written to the trace file, so that we can
107
# show relative times since startup.
108
_brz_log_start_time = breezy._start_time
111
# held in a global for quick reference
112
_brz_logger = logging.getLogger('brz')
115
def note(*args, **kwargs):
116
"""Output a note to the user.
118
Takes the same parameters as logging.info.
122
# FIXME: clearing the ui and then going through the abstract logging
123
# framework is whack; we should probably have a logging Handler that
124
# deals with terminal output if needed.
125
ui.ui_factory.clear_term()
126
_brz_logger.info(*args, **kwargs)
129
def warning(*args, **kwargs):
130
ui.ui_factory.clear_term()
131
_brz_logger.warning(*args, **kwargs)
134
def show_error(*args, **kwargs):
135
"""Show an error message to the user.
137
Don't use this for exceptions, use report_exception instead.
139
_brz_logger.error(*args, **kwargs)
143
"""Compat class for displaying bytes on Python 2."""
146
return 'b' + str.__repr__(self)
148
def __unicode__(self):
149
return self.decode('ascii', 'replace')
152
def mutter(fmt, *args):
153
if _trace_file is None:
155
# XXX: Don't check this every time; instead anyone who closes the file
156
# ought to deregister it. We can tolerate None.
157
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
160
# Let format strings be specified as ascii bytes to help Python 2
161
if isinstance(fmt, bytes):
162
fmt = fmt.decode('ascii', 'replace')
167
_Bytes(arg) if isinstance(arg, bytes) else arg for arg in args)
172
out = '%0.3f %s\n' % (now - _brz_log_start_time, out)
173
_trace_file.write(out.encode('utf-8'))
174
# there's no explicit flushing; the file is typically line buffered.
177
def mutter_callsite(stacklevel, fmt, *args):
178
"""Perform a mutter of fmt and args, logging the call trace.
180
:param stacklevel: The number of frames to show. None will show all
182
:param fmt: The format string to pass to mutter.
183
:param args: A list of substitution variables.
186
if stacklevel is None:
189
limit = stacklevel + 1
190
traceback.print_stack(limit=limit, file=outf)
191
formatted_lines = outf.getvalue().splitlines()
192
formatted_stack = '\n'.join(formatted_lines[:-2])
193
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
196
def _rollover_trace_maybe(trace_fname):
199
size = os.stat(trace_fname)[stat.ST_SIZE]
202
old_fname = trace_fname + '.old'
203
osutils.rename(trace_fname, old_fname)
208
def _get_brz_log_filename():
209
"""Return the brz log filename.
211
:return: A path to the log file
212
:raise EnvironmentError: If the cache directory could not be created
214
brz_log = osutils.path_from_environ('BRZ_LOG')
217
return os.path.join(bedding.cache_dir(), 'brz.log')
221
"""Open the brz.log trace file.
223
If the log is more than a particular length, the old file is renamed to
224
brz.log.old and a new file is started. Otherwise, we append to the
227
This sets the global _brz_log_filename.
229
global _brz_log_filename
231
def _open_or_create_log_file(filename):
232
"""Open existing log file, or create with ownership and permissions
234
It inherits the ownership and permissions (masked by umask) from
235
the containing directory to cope better with being run under sudo
236
with $HOME still set to the user's homedir.
238
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
241
fd = os.open(filename, flags)
244
if e.errno != errno.ENOENT:
247
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0o666)
249
if e.errno != errno.EEXIST:
252
osutils.copy_ownership_from_path(filename)
254
return os.fdopen(fd, 'ab', 0) # unbuffered
257
_brz_log_filename = _get_brz_log_filename()
258
_rollover_trace_maybe(_brz_log_filename)
260
brz_log_file = _open_or_create_log_file(_brz_log_filename)
261
brz_log_file.write(b'\n')
262
if brz_log_file.tell() <= 2:
264
b"this is a debug log for diagnosing/reporting problems in brz\n")
266
b"you can delete or truncate this file, or include sections in\n")
268
b"bug reports to https://bugs.launchpad.net/brz/+filebug\n\n")
272
except EnvironmentError as e:
273
# If we are failing to open the log, then most likely logging has not
274
# been set up yet. So we just write to stderr rather than using
275
# 'warning()'. If we using warning(), users get the unhelpful 'no
276
# handlers registered for "brz"' when something goes wrong on the
277
# server. (bug #503886)
278
sys.stderr.write("failed to open trace file: %s\n" % (e,))
279
# TODO: What should happen if we fail to open the trace file? Maybe the
280
# objects should be pointed at /dev/null or the equivalent? Currently
281
# returns None which will cause failures later.
285
def enable_default_logging():
286
"""Configure default logging: messages to stderr and debug to brz.log
288
This should only be called once per process.
290
Non-command-line programs embedding breezy do not need to call this. They
291
can instead either pass a file to _push_log_file, or act directly on
292
logging.getLogger("brz").
294
Output can be redirected away by calling _push_log_file.
296
:return: A memento from push_log_file for restoring the log state.
298
start_time = osutils.format_local_date(_brz_log_start_time,
300
brz_log_file = _open_brz_log()
301
if brz_log_file is not None:
302
brz_log_file.write(start_time.encode('utf-8') + b'\n')
303
memento = push_log_file(
305
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
306
r'%Y-%m-%d %H:%M:%S')
307
# after hooking output into brz_log, we also need to attach a stderr
308
# handler, writing only at level info and with encoding
309
if sys.version_info[0] == 2:
310
stderr_handler = EncodedStreamHandler(
311
sys.stderr, osutils.get_terminal_encoding(), 'replace',
314
stderr_handler = logging.StreamHandler(stream=sys.stderr)
315
logging.getLogger('brz').addHandler(stderr_handler)
319
def push_log_file(to_file, log_format=None, date_format=None):
320
"""Intercept log and trace messages and send them to a file.
322
:param to_file: A file-like object to which messages will be sent.
324
:returns: A memento that should be passed to _pop_log_file to restore the
325
previously active logging.
329
new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
330
if log_format is None:
331
log_format = '%(levelname)8s %(message)s'
332
new_handler.setFormatter(logging.Formatter(log_format, date_format))
333
# save and remove any existing log handlers
334
brz_logger = logging.getLogger('brz')
335
old_handlers = brz_logger.handlers[:]
336
del brz_logger.handlers[:]
337
# set that as the default logger
338
brz_logger.addHandler(new_handler)
339
brz_logger.setLevel(logging.DEBUG)
340
# TODO: check if any changes are needed to the root logger
342
# TODO: also probably need to save and restore the level on brz_logger.
343
# but maybe we can avoid setting the logger level altogether, and just set
344
# the level on the handler?
346
# save the old trace file
347
old_trace_file = _trace_file
348
# send traces to the new one
349
_trace_file = to_file
350
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
353
def pop_log_file(entry):
354
"""Undo changes to logging/tracing done by _push_log_file.
356
This flushes, but does not close the trace file (so that anything that was
359
Takes the memento returned from _push_log_file."""
360
(magic, old_handlers, new_handler, old_trace_file, new_trace_file) = entry
362
_trace_file = old_trace_file
363
brz_logger = logging.getLogger('brz')
364
brz_logger.removeHandler(new_handler)
365
# must be closed, otherwise logging will try to close it at exit, and the
366
# file will likely already be closed underneath.
368
brz_logger.handlers = old_handlers
369
if new_trace_file is not None:
370
new_trace_file.flush()
373
def log_exception_quietly():
374
"""Log the last exception to the trace file only.
376
Used for exceptions that occur internally and that may be
377
interesting to developers but not to users. For example,
378
errors loading plugins.
380
mutter(traceback.format_exc())
383
def set_verbosity_level(level):
384
"""Set the verbosity level.
386
:param level: -ve for quiet, 0 for normal, +ve for verbose
388
global _verbosity_level
389
_verbosity_level = level
390
_update_logging_level(level < 0)
391
ui.ui_factory.be_quiet(level < 0)
394
def get_verbosity_level():
395
"""Get the verbosity level.
397
See set_verbosity_level() for values.
399
return _verbosity_level
402
def be_quiet(quiet=True):
404
set_verbosity_level(-1)
406
set_verbosity_level(0)
409
def _update_logging_level(quiet=True):
410
"""Hide INFO messages if quiet."""
412
_brz_logger.setLevel(logging.WARNING)
414
_brz_logger.setLevel(logging.INFO)
418
"""Is the verbosity level negative?"""
419
return _verbosity_level < 0
423
"""Is the verbosity level positive?"""
424
return _verbosity_level > 0
427
def debug_memory(message='', short=True):
428
"""Write out a memory dump."""
429
if sys.platform == 'win32':
430
from breezy import win32utils
431
win32utils.debug_memory_win32api(message=message, short=short)
433
_debug_memory_proc(message=message, short=short)
436
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
439
def _debug_memory_proc(message='', short=True):
441
status_file = open('/proc/%s/status' % os.getpid(), 'rb')
445
status = status_file.read()
450
for line in status.splitlines():
454
for field in _short_fields:
455
if line.startswith(field):
460
def _dump_memory_usage(err_file):
463
fd, name = tempfile.mkstemp(prefix="brz_memdump", suffix=".json")
464
dump_file = os.fdopen(fd, 'w')
465
from meliae import scanner
466
scanner.dump_gc_objects(dump_file)
467
err_file.write("Memory dumped to %s\n" % name)
469
err_file.write("Dumping memory requires meliae module.\n")
470
log_exception_quietly()
471
except BaseException:
472
err_file.write("Exception while dumping memory.\n")
473
log_exception_quietly()
475
if dump_file is not None:
481
def _qualified_exception_name(eclass, unqualified_breezy_errors=False):
482
"""Give name of error class including module for non-builtin exceptions
484
If `unqualified_breezy_errors` is True, errors specific to breezy will
485
also omit the module prefix.
487
class_name = eclass.__name__
488
module_name = eclass.__module__
489
if module_name in ("builtins", "exceptions", "__main__") or (
490
unqualified_breezy_errors and module_name == "breezy.errors"):
492
return "%s.%s" % (module_name, class_name)
495
def report_exception(exc_info, err_file):
496
"""Report an exception to err_file (typically stderr) and to brz.log.
498
This will show either a full traceback or a short message as appropriate.
500
:return: The appropriate exit code for this error.
502
# Log the full traceback to brz.log
503
log_exception_quietly()
504
if 'error' in debug.debug_flags:
505
print_exception(exc_info, err_file)
506
return errors.EXIT_ERROR
507
exc_type, exc_object, exc_tb = exc_info
508
if isinstance(exc_object, KeyboardInterrupt):
509
err_file.write("brz: interrupted\n")
510
return errors.EXIT_ERROR
511
elif isinstance(exc_object, MemoryError):
512
err_file.write("brz: out of memory\n")
513
if 'mem_dump' in debug.debug_flags:
514
_dump_memory_usage(err_file)
516
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
517
return errors.EXIT_ERROR
518
elif isinstance(exc_object, ImportError) \
519
and str(exc_object).startswith("No module named "):
522
'You may need to install this Python library separately.')
523
return errors.EXIT_ERROR
524
elif not getattr(exc_object, 'internal_error', True):
525
report_user_error(exc_info, err_file)
526
return errors.EXIT_ERROR
527
elif osutils.is_environment_error(exc_object):
528
if getattr(exc_object, 'errno', None) == errno.EPIPE:
529
err_file.write("brz: broken pipe\n")
530
return errors.EXIT_ERROR
531
# Might be nice to catch all of these and show them as something more
532
# specific, but there are too many cases at the moment.
533
report_user_error(exc_info, err_file)
534
return errors.EXIT_ERROR
536
report_bug(exc_info, err_file)
537
return errors.EXIT_INTERNAL_ERROR
540
def print_exception(exc_info, err_file):
541
exc_type, exc_object, exc_tb = exc_info
542
err_file.write("brz: ERROR: %s: %s\n" % (
543
_qualified_exception_name(exc_type), exc_object))
545
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
548
# TODO: Should these be specially encoding the output?
549
def report_user_error(exc_info, err_file, advice=None):
550
"""Report to err_file an error that's not an internal error.
552
These don't get a traceback unless -Derror was given.
554
:param exc_info: 3-tuple from sys.exc_info()
555
:param advice: Extra advice to the user to be printed following the
558
err_file.write(("brz: ERROR: %s\n" % (str(exc_info[1]),)))
560
err_file.write(("%s\n" % advice))
563
def report_bug(exc_info, err_file):
564
"""Report an exception that probably indicates a bug in brz"""
565
from breezy.crash import report_bug
566
report_bug(exc_info, err_file)
569
def _flush_stdout_stderr():
570
# called from the breezy library finalizer returned by breezy.initialize()
575
# On Windows, I get ValueError calling stdout.flush() on a closed
580
if e.errno in [errno.EINVAL, errno.EPIPE]:
587
# called from the breezy library finalizer returned by breezy.initialize()
593
class EncodedStreamHandler(logging.Handler):
594
"""Robustly write logging events to a stream using the specified encoding
596
Messages are expected to be formatted to unicode, but UTF-8 byte strings
597
are also accepted. An error during formatting or a str message in another
598
encoding will be quitely noted as an error in the Bazaar log file.
600
The stream is not closed so sys.stdout or sys.stderr may be passed.
603
def __init__(self, stream, encoding=None, errors='strict', level=0):
604
logging.Handler.__init__(self, level)
607
encoding = getattr(stream, "encoding", "ascii")
608
self.encoding = encoding
612
flush = getattr(self.stream, "flush", None)
613
if flush is not None:
616
def emit(self, record):
618
if not isinstance(record.msg, text_type):
619
msg = record.msg.decode("utf-8")
622
line = self.format(record)
623
if not isinstance(line, text_type):
624
line = line.decode("utf-8")
625
self.stream.write(line.encode(self.encoding, self.errors) + b"\n")
627
log_exception_quietly()
628
# Try saving the details that would have been logged in some form
629
msg = args = "<Unformattable>"
631
msg = repr(record.msg)
632
args = repr(record.args)
635
# Using mutter() bypasses the logging module and writes directly
636
# to the file so there's no danger of getting into a loop here.
637
mutter("Logging record unformattable: %s %% %s", msg, args)
640
class Config(object):
641
"""Configuration of message tracing in breezy.
643
This implements the context manager protocol and should manage any global
644
variables still used. The default config used is DefaultConfig, but
645
embedded uses of breezy may wish to use a custom manager.
649
return self # This is bound to the 'as' clause in a with statement.
651
def __exit__(self, exc_type, exc_val, exc_tb):
652
return False # propogate exceptions.
655
class DefaultConfig(Config):
656
"""A default configuration for tracing of messages in breezy.
658
This implements the context manager protocol.
662
self._original_filename = _brz_log_filename
663
self._original_state = enable_default_logging()
664
return self # This is bound to the 'as' clause in a with statement.
666
def __exit__(self, exc_type, exc_val, exc_tb):
667
pop_log_file(self._original_state)
668
global _brz_log_filename
669
_brz_log_filename = self._original_filename
670
return False # propogate exceptions.
added
removed
breezy/trace.py
