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
60
from io import StringIO
66
from .lazy_import import lazy_import
67
lazy_import(globals(), """
74
lazy_import(globals(), """
87
# global verbosity for breezy; controls the log level for stderr; 0=normal; <0
88
# is quiet; >0 is verbose.
91
# File-like object where mutter/debug output is currently sent. Can be
92
# changed by _push_log_file etc. This is directly manipulated by some
93
# external code; maybe there should be functions to do that more precisely
94
# than push/pop_log_file.
97
# Absolute path for brz.log. Not changed even if the log/trace output is
98
# redirected elsewhere. Used to show the location in --version.
99
_brz_log_filename = None
101
# The time the first message was written to the trace file, so that we can
102
# show relative times since startup.
103
_brz_log_start_time = breezy._start_time
106
# held in a global for quick reference
107
_brz_logger = logging.getLogger('brz')
110
def note(*args, **kwargs):
111
"""Output a note to the user.
113
Takes the same parameters as logging.info.
117
# FIXME: clearing the ui and then going through the abstract logging
118
# framework is whack; we should probably have a logging Handler that
119
# deals with terminal output if needed.
120
ui.ui_factory.clear_term()
121
_brz_logger.info(*args, **kwargs)
124
def warning(*args, **kwargs):
125
ui.ui_factory.clear_term()
126
_brz_logger.warning(*args, **kwargs)
129
def show_error(*args, **kwargs):
130
"""Show an error message to the user.
132
Don't use this for exceptions, use report_exception instead.
134
_brz_logger.error(*args, **kwargs)
138
"""Compat class for displaying bytes on Python 2."""
141
return 'b' + str.__repr__(self)
143
def __unicode__(self):
144
return self.decode('ascii', 'replace')
147
def mutter(fmt, *args):
148
if _trace_file is None:
150
# XXX: Don't check this every time; instead anyone who closes the file
151
# ought to deregister it. We can tolerate None.
152
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
155
# Let format strings be specified as ascii bytes to help Python 2
156
if isinstance(fmt, bytes):
157
fmt = fmt.decode('ascii', 'replace')
164
out = '%0.3f %s\n' % (now - _brz_log_start_time, out)
165
_trace_file.write(out.encode('utf-8'))
166
# there's no explicit flushing; the file is typically line buffered.
169
def mutter_callsite(stacklevel, fmt, *args):
170
"""Perform a mutter of fmt and args, logging the call trace.
172
:param stacklevel: The number of frames to show. None will show all
174
:param fmt: The format string to pass to mutter.
175
:param args: A list of substitution variables.
178
if stacklevel is None:
181
limit = stacklevel + 1
182
traceback.print_stack(limit=limit, file=outf)
183
formatted_lines = outf.getvalue().splitlines()
184
formatted_stack = '\n'.join(formatted_lines[:-2])
185
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
188
def _rollover_trace_maybe(trace_fname):
191
size = os.stat(trace_fname)[stat.ST_SIZE]
194
old_fname = trace_fname + '.old'
195
osutils.rename(trace_fname, old_fname)
200
def _get_brz_log_filename():
201
"""Return the brz log filename.
203
:return: A path to the log file
204
:raise EnvironmentError: If the cache directory could not be created
206
brz_log = osutils.path_from_environ('BRZ_LOG')
209
return os.path.join(bedding.cache_dir(), 'brz.log')
213
"""Open the brz.log trace file.
215
If the log is more than a particular length, the old file is renamed to
216
brz.log.old and a new file is started. Otherwise, we append to the
219
This sets the global _brz_log_filename.
221
global _brz_log_filename
223
def _open_or_create_log_file(filename):
224
"""Open existing log file, or create with ownership and permissions
226
It inherits the ownership and permissions (masked by umask) from
227
the containing directory to cope better with being run under sudo
228
with $HOME still set to the user's homedir.
230
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
233
fd = os.open(filename, flags)
236
if e.errno != errno.ENOENT:
239
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0o666)
241
if e.errno != errno.EEXIST:
244
osutils.copy_ownership_from_path(filename)
246
return os.fdopen(fd, 'ab', 0) # unbuffered
249
_brz_log_filename = _get_brz_log_filename()
250
_rollover_trace_maybe(_brz_log_filename)
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:
256
b"this is a debug log for diagnosing/reporting problems in brz\n")
258
b"you can delete or truncate this file, or include sections in\n")
260
b"bug reports to https://bugs.launchpad.net/brz/+filebug\n\n")
264
except EnvironmentError as e:
265
# If we are failing to open the log, then most likely logging has not
266
# been set up yet. So we just write to stderr rather than using
267
# 'warning()'. If we using warning(), users get the unhelpful 'no
268
# handlers registered for "brz"' when something goes wrong on the
269
# server. (bug #503886)
270
sys.stderr.write("failed to open trace file: %s\n" % (e,))
271
# TODO: What should happen if we fail to open the trace file? Maybe the
272
# objects should be pointed at /dev/null or the equivalent? Currently
273
# returns None which will cause failures later.
277
def enable_default_logging():
278
"""Configure default logging: messages to stderr and debug to brz.log
280
This should only be called once per process.
282
Non-command-line programs embedding breezy do not need to call this. They
283
can instead either pass a file to _push_log_file, or act directly on
284
logging.getLogger("brz").
286
Output can be redirected away by calling _push_log_file.
288
:return: A memento from push_log_file for restoring the log state.
290
start_time = osutils.format_local_date(_brz_log_start_time,
292
brz_log_file = _open_brz_log()
293
if brz_log_file is not None:
294
brz_log_file.write(start_time.encode('utf-8') + b'\n')
295
memento = push_log_file(
297
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
298
r'%Y-%m-%d %H:%M:%S')
299
# after hooking output into brz_log, we also need to attach a stderr
300
# handler, writing only at level info and with encoding
301
stderr_handler = logging.StreamHandler(stream=sys.stderr)
302
logging.getLogger('brz').addHandler(stderr_handler)
306
def push_log_file(to_file, log_format=None, date_format=None):
307
"""Intercept log and trace messages and send them to a file.
309
:param to_file: A file-like object to which messages will be sent.
311
:returns: A memento that should be passed to _pop_log_file to restore the
312
previously active logging.
316
new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
317
if log_format is None:
318
log_format = '%(levelname)8s %(message)s'
319
new_handler.setFormatter(logging.Formatter(log_format, date_format))
320
# save and remove any existing log handlers
321
brz_logger = logging.getLogger('brz')
322
old_handlers = brz_logger.handlers[:]
323
del brz_logger.handlers[:]
324
# set that as the default logger
325
brz_logger.addHandler(new_handler)
326
brz_logger.setLevel(logging.DEBUG)
327
# TODO: check if any changes are needed to the root logger
329
# TODO: also probably need to save and restore the level on brz_logger.
330
# but maybe we can avoid setting the logger level altogether, and just set
331
# the level on the handler?
333
# save the old trace file
334
old_trace_file = _trace_file
335
# send traces to the new one
336
_trace_file = to_file
337
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
340
def pop_log_file(entry):
341
"""Undo changes to logging/tracing done by _push_log_file.
343
This flushes, but does not close the trace file (so that anything that was
346
Takes the memento returned from _push_log_file."""
347
(magic, old_handlers, new_handler, old_trace_file, new_trace_file) = entry
349
_trace_file = old_trace_file
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
353
# file will likely already be closed underneath.
355
brz_logger.handlers = old_handlers
356
if new_trace_file is not None:
357
new_trace_file.flush()
360
def log_exception_quietly():
361
"""Log the last exception to the trace file only.
363
Used for exceptions that occur internally and that may be
364
interesting to developers but not to users. For example,
365
errors loading plugins.
367
mutter(traceback.format_exc())
370
def set_verbosity_level(level):
371
"""Set the verbosity level.
373
:param level: -ve for quiet, 0 for normal, +ve for verbose
375
global _verbosity_level
376
_verbosity_level = level
377
_update_logging_level(level < 0)
378
ui.ui_factory.be_quiet(level < 0)
381
def get_verbosity_level():
382
"""Get the verbosity level.
384
See set_verbosity_level() for values.
386
return _verbosity_level
389
def be_quiet(quiet=True):
391
set_verbosity_level(-1)
393
set_verbosity_level(0)
396
def _update_logging_level(quiet=True):
397
"""Hide INFO messages if quiet."""
399
_brz_logger.setLevel(logging.WARNING)
401
_brz_logger.setLevel(logging.INFO)
405
"""Is the verbosity level negative?"""
406
return _verbosity_level < 0
410
"""Is the verbosity level positive?"""
411
return _verbosity_level > 0
414
def debug_memory(message='', short=True):
415
"""Write out a memory dump."""
416
if sys.platform == 'win32':
417
from breezy import win32utils
418
win32utils.debug_memory_win32api(message=message, short=short)
420
_debug_memory_proc(message=message, short=short)
423
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
426
def _debug_memory_proc(message='', short=True):
428
status_file = open('/proc/%s/status' % os.getpid(), 'rb')
432
status = status_file.read()
437
for line in status.splitlines():
441
for field in _short_fields:
442
if line.startswith(field):
447
def _dump_memory_usage(err_file):
450
fd, name = tempfile.mkstemp(prefix="brz_memdump", suffix=".json")
451
dump_file = os.fdopen(fd, 'w')
452
from meliae import scanner
453
scanner.dump_gc_objects(dump_file)
454
err_file.write("Memory dumped to %s\n" % name)
456
err_file.write("Dumping memory requires meliae module.\n")
457
log_exception_quietly()
458
except BaseException:
459
err_file.write("Exception while dumping memory.\n")
460
log_exception_quietly()
462
if dump_file is not None:
468
def _qualified_exception_name(eclass, unqualified_breezy_errors=False):
469
"""Give name of error class including module for non-builtin exceptions
471
If `unqualified_breezy_errors` is True, errors specific to breezy will
472
also omit the module prefix.
474
class_name = eclass.__name__
475
module_name = eclass.__module__
476
if module_name in ("builtins", "exceptions", "__main__") or (
477
unqualified_breezy_errors and module_name == "breezy.errors"):
479
return "%s.%s" % (module_name, class_name)
482
def report_exception(exc_info, err_file):
483
"""Report an exception to err_file (typically stderr) and to brz.log.
485
This will show either a full traceback or a short message as appropriate.
487
:return: The appropriate exit code for this error.
489
# Log the full traceback to brz.log
490
log_exception_quietly()
491
if 'error' in debug.debug_flags:
492
print_exception(exc_info, err_file)
493
return errors.EXIT_ERROR
494
exc_type, exc_object, exc_tb = exc_info
495
if isinstance(exc_object, KeyboardInterrupt):
496
err_file.write("brz: interrupted\n")
497
return errors.EXIT_ERROR
498
elif isinstance(exc_object, MemoryError):
499
err_file.write("brz: out of memory\n")
500
if 'mem_dump' in debug.debug_flags:
501
_dump_memory_usage(err_file)
503
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
504
return errors.EXIT_ERROR
505
elif isinstance(exc_object, ImportError) \
506
and str(exc_object).startswith("No module named "):
509
'You may need to install this Python library separately.')
510
return errors.EXIT_ERROR
511
elif not getattr(exc_object, 'internal_error', True):
512
report_user_error(exc_info, err_file)
513
return errors.EXIT_ERROR
514
elif osutils.is_environment_error(exc_object):
515
if getattr(exc_object, 'errno', None) == errno.EPIPE:
516
err_file.write("brz: broken pipe\n")
517
return errors.EXIT_ERROR
518
# Might be nice to catch all of these and show them as something more
519
# specific, but there are too many cases at the moment.
520
report_user_error(exc_info, err_file)
521
return errors.EXIT_ERROR
523
report_bug(exc_info, err_file)
524
return errors.EXIT_INTERNAL_ERROR
527
def print_exception(exc_info, err_file):
528
exc_type, exc_object, exc_tb = exc_info
529
err_file.write("brz: ERROR: %s: %s\n" % (
530
_qualified_exception_name(exc_type), exc_object))
532
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
535
# TODO: Should these be specially encoding the output?
536
def report_user_error(exc_info, err_file, advice=None):
537
"""Report to err_file an error that's not an internal error.
539
These don't get a traceback unless -Derror was given.
541
:param exc_info: 3-tuple from sys.exc_info()
542
:param advice: Extra advice to the user to be printed following the
545
err_file.write(("brz: ERROR: %s\n" % (str(exc_info[1]),)))
547
err_file.write(("%s\n" % advice))
550
def report_bug(exc_info, err_file):
551
"""Report an exception that probably indicates a bug in brz"""
552
from breezy.crash import report_bug
553
report_bug(exc_info, err_file)
556
def _flush_stdout_stderr():
557
# called from the breezy library finalizer returned by breezy.initialize()
562
# On Windows, I get ValueError calling stdout.flush() on a closed
567
if e.errno in [errno.EINVAL, errno.EPIPE]:
574
# called from the breezy library finalizer returned by breezy.initialize()
580
class EncodedStreamHandler(logging.Handler):
581
"""Robustly write logging events to a stream using the specified encoding
583
Messages are expected to be formatted to unicode, but UTF-8 byte strings
584
are also accepted. An error during formatting or a str message in another
585
encoding will be quitely noted as an error in the Bazaar log file.
587
The stream is not closed so sys.stdout or sys.stderr may be passed.
590
def __init__(self, stream, encoding=None, errors='strict', level=0):
591
logging.Handler.__init__(self, level)
594
encoding = getattr(stream, "encoding", "ascii")
595
self.encoding = encoding
599
flush = getattr(self.stream, "flush", None)
600
if flush is not None:
603
def emit(self, record):
605
if not isinstance(record.msg, str):
606
msg = record.msg.decode("utf-8")
608
line = self.format(record)
609
if not isinstance(line, str):
610
line = line.decode("utf-8")
611
self.stream.write(line.encode(self.encoding, self.errors) + b"\n")
613
log_exception_quietly()
614
# Try saving the details that would have been logged in some form
615
msg = args = "<Unformattable>"
617
msg = repr(record.msg)
618
args = repr(record.args)
621
# Using mutter() bypasses the logging module and writes directly
622
# to the file so there's no danger of getting into a loop here.
623
mutter("Logging record unformattable: %s %% %s", msg, args)
626
class Config(object):
627
"""Configuration of message tracing in breezy.
629
This implements the context manager protocol and should manage any global
630
variables still used. The default config used is DefaultConfig, but
631
embedded uses of breezy may wish to use a custom manager.
635
return self # This is bound to the 'as' clause in a with statement.
637
def __exit__(self, exc_type, exc_val, exc_tb):
638
return False # propogate exceptions.
641
class DefaultConfig(Config):
642
"""A default configuration for tracing of messages in breezy.
644
This implements the context manager protocol.
648
self._original_filename = _brz_log_filename
649
self._original_state = enable_default_logging()
650
return self # This is bound to the 'as' clause in a with statement.
652
def __exit__(self, exc_type, exc_val, exc_tb):
653
pop_log_file(self._original_state)
654
global _brz_log_filename
655
_brz_log_filename = self._original_filename
656
return False # propogate exceptions.
added
removed
breezy/trace.py
