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
brz_log = osutils.path_from_environ('BRZ_LOG')
210
return os.path.join(bedding.cache_dir(), 'brz.log')
214
"""Open the brz.log trace file.
216
If the log is more than a particular length, the old file is renamed to
217
brz.log.old and a new file is started. Otherwise, we append to the
220
This sets the global _brz_log_filename.
222
global _brz_log_filename
224
def _open_or_create_log_file(filename):
225
"""Open existing log file, or create with ownership and permissions
227
It inherits the ownership and permissions (masked by umask) from
228
the containing directory to cope better with being run under sudo
229
with $HOME still set to the user's homedir.
231
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
234
fd = os.open(filename, flags)
237
if e.errno != errno.ENOENT:
240
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0o666)
242
if e.errno != errno.EEXIST:
245
osutils.copy_ownership_from_path(filename)
247
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
if sys.version_info[0] == 2:
302
stderr_handler = EncodedStreamHandler(
303
sys.stderr, osutils.get_terminal_encoding(), 'replace',
306
stderr_handler = logging.StreamHandler(stream=sys.stderr)
307
logging.getLogger('brz').addHandler(stderr_handler)
311
def push_log_file(to_file, log_format=None, date_format=None):
312
"""Intercept log and trace messages and send them to a file.
314
:param to_file: A file-like object to which messages will be sent.
316
:returns: A memento that should be passed to _pop_log_file to restore the
317
previously active logging.
321
new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
322
if log_format is None:
323
log_format = '%(levelname)8s %(message)s'
324
new_handler.setFormatter(logging.Formatter(log_format, date_format))
325
# save and remove any existing log handlers
326
brz_logger = logging.getLogger('brz')
327
old_handlers = brz_logger.handlers[:]
328
del brz_logger.handlers[:]
329
# set that as the default logger
330
brz_logger.addHandler(new_handler)
331
brz_logger.setLevel(logging.DEBUG)
332
# TODO: check if any changes are needed to the root logger
334
# TODO: also probably need to save and restore the level on brz_logger.
335
# but maybe we can avoid setting the logger level altogether, and just set
336
# the level on the handler?
338
# save the old trace file
339
old_trace_file = _trace_file
340
# send traces to the new one
341
_trace_file = to_file
342
return ('log_memento', old_handlers, new_handler, old_trace_file, to_file)
345
def pop_log_file(entry):
346
"""Undo changes to logging/tracing done by _push_log_file.
348
This flushes, but does not close the trace file (so that anything that was
351
Takes the memento returned from _push_log_file."""
352
(magic, old_handlers, new_handler, old_trace_file, new_trace_file) = entry
354
_trace_file = old_trace_file
355
brz_logger = logging.getLogger('brz')
356
brz_logger.removeHandler(new_handler)
357
# must be closed, otherwise logging will try to close it at exit, and the
358
# file will likely already be closed underneath.
360
brz_logger.handlers = old_handlers
361
if new_trace_file is not None:
362
new_trace_file.flush()
365
def log_exception_quietly():
366
"""Log the last exception to the trace file only.
368
Used for exceptions that occur internally and that may be
369
interesting to developers but not to users. For example,
370
errors loading plugins.
372
mutter(traceback.format_exc())
375
def set_verbosity_level(level):
376
"""Set the verbosity level.
378
:param level: -ve for quiet, 0 for normal, +ve for verbose
380
global _verbosity_level
381
_verbosity_level = level
382
_update_logging_level(level < 0)
383
ui.ui_factory.be_quiet(level < 0)
386
def get_verbosity_level():
387
"""Get the verbosity level.
389
See set_verbosity_level() for values.
391
return _verbosity_level
394
def be_quiet(quiet=True):
396
set_verbosity_level(-1)
398
set_verbosity_level(0)
401
def _update_logging_level(quiet=True):
402
"""Hide INFO messages if quiet."""
404
_brz_logger.setLevel(logging.WARNING)
406
_brz_logger.setLevel(logging.INFO)
410
"""Is the verbosity level negative?"""
411
return _verbosity_level < 0
415
"""Is the verbosity level positive?"""
416
return _verbosity_level > 0
419
def debug_memory(message='', short=True):
420
"""Write out a memory dump."""
421
if sys.platform == 'win32':
422
from breezy import win32utils
423
win32utils.debug_memory_win32api(message=message, short=short)
425
_debug_memory_proc(message=message, short=short)
428
_short_fields = ('VmPeak', 'VmSize', 'VmRSS')
431
def _debug_memory_proc(message='', short=True):
433
status_file = open('/proc/%s/status' % os.getpid(), 'rb')
437
status = status_file.read()
442
for line in status.splitlines():
446
for field in _short_fields:
447
if line.startswith(field):
452
def _dump_memory_usage(err_file):
455
fd, name = tempfile.mkstemp(prefix="brz_memdump", suffix=".json")
456
dump_file = os.fdopen(fd, 'w')
457
from meliae import scanner
458
scanner.dump_gc_objects(dump_file)
459
err_file.write("Memory dumped to %s\n" % name)
461
err_file.write("Dumping memory requires meliae module.\n")
462
log_exception_quietly()
463
except BaseException:
464
err_file.write("Exception while dumping memory.\n")
465
log_exception_quietly()
467
if dump_file is not None:
473
def _qualified_exception_name(eclass, unqualified_breezy_errors=False):
474
"""Give name of error class including module for non-builtin exceptions
476
If `unqualified_breezy_errors` is True, errors specific to breezy will
477
also omit the module prefix.
479
class_name = eclass.__name__
480
module_name = eclass.__module__
481
if module_name in ("builtins", "exceptions", "__main__") or (
482
unqualified_breezy_errors and module_name == "breezy.errors"):
484
return "%s.%s" % (module_name, class_name)
487
def report_exception(exc_info, err_file):
488
"""Report an exception to err_file (typically stderr) and to brz.log.
490
This will show either a full traceback or a short message as appropriate.
492
:return: The appropriate exit code for this error.
494
# Log the full traceback to brz.log
495
log_exception_quietly()
496
if 'error' in debug.debug_flags:
497
print_exception(exc_info, err_file)
498
return errors.EXIT_ERROR
499
exc_type, exc_object, exc_tb = exc_info
500
if isinstance(exc_object, KeyboardInterrupt):
501
err_file.write("brz: interrupted\n")
502
return errors.EXIT_ERROR
503
elif isinstance(exc_object, MemoryError):
504
err_file.write("brz: out of memory\n")
505
if 'mem_dump' in debug.debug_flags:
506
_dump_memory_usage(err_file)
508
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
509
return errors.EXIT_ERROR
510
elif isinstance(exc_object, ImportError) \
511
and str(exc_object).startswith("No module named "):
514
'You may need to install this Python library separately.')
515
return errors.EXIT_ERROR
516
elif not getattr(exc_object, 'internal_error', True):
517
report_user_error(exc_info, err_file)
518
return errors.EXIT_ERROR
519
elif osutils.is_environment_error(exc_object):
520
if getattr(exc_object, 'errno', None) == errno.EPIPE:
521
err_file.write("brz: broken pipe\n")
522
return errors.EXIT_ERROR
523
# Might be nice to catch all of these and show them as something more
524
# specific, but there are too many cases at the moment.
525
report_user_error(exc_info, err_file)
526
return errors.EXIT_ERROR
528
report_bug(exc_info, err_file)
529
return errors.EXIT_INTERNAL_ERROR
532
def print_exception(exc_info, err_file):
533
exc_type, exc_object, exc_tb = exc_info
534
err_file.write("brz: ERROR: %s: %s\n" % (
535
_qualified_exception_name(exc_type), exc_object))
537
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
540
# TODO: Should these be specially encoding the output?
541
def report_user_error(exc_info, err_file, advice=None):
542
"""Report to err_file an error that's not an internal error.
544
These don't get a traceback unless -Derror was given.
546
:param exc_info: 3-tuple from sys.exc_info()
547
:param advice: Extra advice to the user to be printed following the
550
err_file.write(("brz: ERROR: %s\n" % (str(exc_info[1]),)))
552
err_file.write(("%s\n" % advice))
555
def report_bug(exc_info, err_file):
556
"""Report an exception that probably indicates a bug in brz"""
557
from breezy.crash import report_bug
558
report_bug(exc_info, err_file)
561
def _flush_stdout_stderr():
562
# called from the breezy library finalizer returned by breezy.initialize()
567
# On Windows, I get ValueError calling stdout.flush() on a closed
572
if e.errno in [errno.EINVAL, errno.EPIPE]:
579
# called from the breezy library finalizer returned by breezy.initialize()
585
class EncodedStreamHandler(logging.Handler):
586
"""Robustly write logging events to a stream using the specified encoding
588
Messages are expected to be formatted to unicode, but UTF-8 byte strings
589
are also accepted. An error during formatting or a str message in another
590
encoding will be quitely noted as an error in the Bazaar log file.
592
The stream is not closed so sys.stdout or sys.stderr may be passed.
595
def __init__(self, stream, encoding=None, errors='strict', level=0):
596
logging.Handler.__init__(self, level)
599
encoding = getattr(stream, "encoding", "ascii")
600
self.encoding = encoding
604
flush = getattr(self.stream, "flush", None)
605
if flush is not None:
608
def emit(self, record):
610
if not isinstance(record.msg, text_type):
611
msg = record.msg.decode("utf-8")
614
line = self.format(record)
615
if not isinstance(line, text_type):
616
line = line.decode("utf-8")
617
self.stream.write(line.encode(self.encoding, self.errors) + b"\n")
619
log_exception_quietly()
620
# Try saving the details that would have been logged in some form
621
msg = args = "<Unformattable>"
623
msg = repr(record.msg)
624
args = repr(record.args)
627
# Using mutter() bypasses the logging module and writes directly
628
# to the file so there's no danger of getting into a loop here.
629
mutter("Logging record unformattable: %s %% %s", msg, args)
632
class Config(object):
633
"""Configuration of message tracing in breezy.
635
This implements the context manager protocol and should manage any global
636
variables still used. The default config used is DefaultConfig, but
637
embedded uses of breezy may wish to use a custom manager.
641
return self # This is bound to the 'as' clause in a with statement.
643
def __exit__(self, exc_type, exc_val, exc_tb):
644
return False # propogate exceptions.
647
class DefaultConfig(Config):
648
"""A default configuration for tracing of messages in breezy.
650
This implements the context manager protocol.
654
self._original_filename = _brz_log_filename
655
self._original_state = enable_default_logging()
656
return self # This is bound to the 'as' clause in a with statement.
658
def __exit__(self, exc_type, exc_val, exc_tb):
659
pop_log_file(self._original_state)
660
global _brz_log_filename
661
_brz_log_filename = self._original_filename
662
return False # propogate exceptions.
added
removed
breezy/trace.py
