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: to stderr, and to ~/.brz.log. For purposes
27
such as running the test suite, they can also be redirected away from both of
28
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(), """
74
lazy_import(globals(), """
91
# global verbosity for breezy; controls the log level for stderr; 0=normal; <0
92
# is quiet; >0 is verbose.
95
# File-like object where mutter/debug output is currently sent. Can be
96
# changed by _push_log_file etc. This is directly manipulated by some
97
# external code; maybe there should be functions to do that more precisely
98
# than push/pop_log_file.
101
# Absolute path for ~/.brz.log. Not changed even if the log/trace output is
102
# redirected elsewhere. Used to show the location in --version.
103
_brz_log_filename = None
105
# The time the first message was written to the trace file, so that we can
106
# show relative times since startup.
107
_brz_log_start_time = breezy._start_time
110
# held in a global for quick reference
111
_brz_logger = logging.getLogger('brz')
114
def note(*args, **kwargs):
115
"""Output a note to the user.
117
Takes the same parameters as logging.info.
121
# FIXME: clearing the ui and then going through the abstract logging
122
# framework is whack; we should probably have a logging Handler that
123
# deals with terminal output if needed.
124
ui.ui_factory.clear_term()
125
_brz_logger.info(*args, **kwargs)
128
def warning(*args, **kwargs):
129
ui.ui_factory.clear_term()
130
_brz_logger.warning(*args, **kwargs)
133
def show_error(*args, **kwargs):
134
"""Show an error message to the user.
136
Don't use this for exceptions, use report_exception instead.
138
_brz_logger.error(*args, **kwargs)
141
def mutter(fmt, *args):
142
if _trace_file is None:
144
# XXX: Don't check this every time; instead anyone who closes the file
145
# ought to deregister it. We can tolerate None.
146
if (getattr(_trace_file, 'closed', None) is not None) and _trace_file.closed:
149
if isinstance(fmt, text_type):
150
fmt = fmt.encode('utf8')
153
# It seems that if we do ascii % (unicode, ascii) we can
154
# get a unicode cannot encode ascii error, so make sure that "fmt"
155
# is a unicode string
158
if isinstance(arg, text_type):
159
arg = arg.encode('utf8')
160
real_args.append(arg)
161
out = fmt % tuple(real_args)
165
out = b'%0.3f %s\n' % (now - _brz_log_start_time, out)
166
_trace_file.write(out)
167
# there's no explicit flushing; the file is typically line buffered.
170
def mutter_callsite(stacklevel, fmt, *args):
171
"""Perform a mutter of fmt and args, logging the call trace.
173
:param stacklevel: The number of frames to show. None will show all
175
:param fmt: The format string to pass to mutter.
176
:param args: A list of substitution variables.
179
if stacklevel is None:
182
limit = stacklevel + 1
183
traceback.print_stack(limit=limit, file=outf)
184
formatted_lines = outf.getvalue().splitlines()
185
formatted_stack = '\n'.join(formatted_lines[:-2])
186
mutter(fmt + "\nCalled from:\n%s", *(args + (formatted_stack,)))
189
def _rollover_trace_maybe(trace_fname):
192
size = os.stat(trace_fname)[stat.ST_SIZE]
195
old_fname = trace_fname + '.old'
196
osutils.rename(trace_fname, old_fname)
201
def _get_brz_log_filename():
202
brz_log = osutils.path_from_environ('BRZ_LOG')
205
home = osutils.path_from_environ('BRZ_HOME')
207
# GZ 2012-02-01: Logging to the home dir is bad, but XDG is unclear
208
# over what would be better. On windows, bug 240550
209
# suggests LOCALAPPDATA be used instead.
210
home = osutils._get_home_dir()
211
return os.path.join(home, '.brz.log')
215
"""Open the .brz.log trace file.
217
If the log is more than a particular length, the old file is renamed to
218
.brz.log.old and a new file is started. Otherwise, we append to the
221
This sets the global _brz_log_filename.
223
global _brz_log_filename
225
def _open_or_create_log_file(filename):
226
"""Open existing log file, or create with ownership and permissions
228
It inherits the ownership and permissions (masked by umask) from
229
the containing directory to cope better with being run under sudo
230
with $HOME still set to the user's homedir.
232
flags = os.O_WRONLY | os.O_APPEND | osutils.O_TEXT
235
fd = os.open(filename, flags)
238
if e.errno != errno.ENOENT:
241
fd = os.open(filename, flags | os.O_CREAT | os.O_EXCL, 0o666)
243
if e.errno != errno.EEXIST:
246
osutils.copy_ownership_from_path(filename)
248
return os.fdopen(fd, 'ab', 0) # unbuffered
251
_brz_log_filename = _get_brz_log_filename()
252
_rollover_trace_maybe(_brz_log_filename)
254
brz_log_file = _open_or_create_log_file(_brz_log_filename)
255
brz_log_file.write(b'\n')
256
if brz_log_file.tell() <= 2:
257
brz_log_file.write(b"this is a debug log for diagnosing/reporting problems in brz\n")
258
brz_log_file.write(b"you can delete or truncate this file, or include sections in\n")
259
brz_log_file.write(b"bug reports to https://bugs.launchpad.net/brz/+filebug\n\n")
263
except EnvironmentError as e:
264
# If we are failing to open the log, then most likely logging has not
265
# been set up yet. So we just write to stderr rather than using
266
# 'warning()'. If we using warning(), users get the unhelpful 'no
267
# handlers registered for "brz"' when something goes wrong on the
268
# server. (bug #503886)
269
sys.stderr.write("failed to open trace file: %s\n" % (e,))
270
# TODO: What should happen if we fail to open the trace file? Maybe the
271
# objects should be pointed at /dev/null or the equivalent? Currently
272
# returns None which will cause failures later.
276
def enable_default_logging():
277
"""Configure default logging: messages to stderr and debug to .brz.log
279
This should only be called once per process.
281
Non-command-line programs embedding breezy do not need to call this. They
282
can instead either pass a file to _push_log_file, or act directly on
283
logging.getLogger("brz").
285
Output can be redirected away by calling _push_log_file.
287
:return: A memento from push_log_file for restoring the log state.
289
start_time = osutils.format_local_date(_brz_log_start_time,
291
brz_log_file = _open_brz_log()
292
if brz_log_file is not None:
293
brz_log_file.write(start_time.encode('utf-8') + b'\n')
294
memento = push_log_file(brz_log_file,
295
r'[%(process)5d] %(asctime)s.%(msecs)03d %(levelname)s: %(message)s',
296
r'%Y-%m-%d %H:%M:%S')
297
# after hooking output into brz_log, we also need to attach a stderr
298
# handler, writing only at level info and with encoding
299
stderr_handler = EncodedStreamHandler(sys.stderr,
300
osutils.get_terminal_encoding(), 'replace', level=logging.INFO)
301
logging.getLogger('brz').addHandler(stderr_handler)
305
def push_log_file(to_file, log_format=None, date_format=None):
306
"""Intercept log and trace messages and send them to a file.
308
:param to_file: A file-like object to which messages will be sent.
310
:returns: A memento that should be passed to _pop_log_file to restore the
311
previously active logging.
315
new_handler = EncodedStreamHandler(to_file, "utf-8", level=logging.DEBUG)
316
if log_format is None:
317
log_format = '%(levelname)8s %(message)s'
318
new_handler.setFormatter(logging.Formatter(log_format, date_format))
319
# save and remove any existing log handlers
320
brz_logger = logging.getLogger('brz')
321
old_handlers = brz_logger.handlers[:]
322
del brz_logger.handlers[:]
323
# set that as the default logger
324
brz_logger.addHandler(new_handler)
325
brz_logger.setLevel(logging.DEBUG)
326
# TODO: check if any changes are needed to the root logger
328
# TODO: also probably need to save and restore the level on brz_logger.
329
# but maybe we can avoid setting the logger level altogether, and just set
330
# the level on the handler?
332
# save the old trace file
333
old_trace_file = _trace_file
334
# send traces to the new one
335
_trace_file = to_file
336
result = new_handler, _trace_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')
425
def _debug_memory_proc(message='', short=True):
427
status_file = file('/proc/%s/status' % os.getpid(), 'rb')
431
status = status_file.read()
436
for line in status.splitlines():
440
for field in _short_fields:
441
if line.startswith(field):
445
def _dump_memory_usage(err_file):
448
fd, name = tempfile.mkstemp(prefix="brz_memdump", suffix=".json")
449
dump_file = os.fdopen(fd, 'w')
450
from meliae import scanner
451
scanner.dump_gc_objects(dump_file)
452
err_file.write("Memory dumped to %s\n" % name)
454
err_file.write("Dumping memory requires meliae module.\n")
455
log_exception_quietly()
457
err_file.write("Exception while dumping memory.\n")
458
log_exception_quietly()
460
if dump_file is not None:
466
def _qualified_exception_name(eclass, unqualified_breezy_errors=False):
467
"""Give name of error class including module for non-builtin exceptions
469
If `unqualified_breezy_errors` is True, errors specific to breezy will
470
also omit the module prefix.
472
class_name = eclass.__name__
473
module_name = eclass.__module__
474
if module_name in ("builtins", "exceptions", "__main__") or (
475
unqualified_breezy_errors and module_name == "breezy.errors"):
477
return "%s.%s" % (module_name, class_name)
480
def report_exception(exc_info, err_file):
481
"""Report an exception to err_file (typically stderr) and to .brz.log.
483
This will show either a full traceback or a short message as appropriate.
485
:return: The appropriate exit code for this error.
487
# Log the full traceback to ~/.brz.log
488
log_exception_quietly()
489
if 'error' in debug.debug_flags:
490
print_exception(exc_info, err_file)
491
return errors.EXIT_ERROR
492
exc_type, exc_object, exc_tb = exc_info
493
if isinstance(exc_object, KeyboardInterrupt):
494
err_file.write("brz: interrupted\n")
495
return errors.EXIT_ERROR
496
elif isinstance(exc_object, MemoryError):
497
err_file.write("brz: out of memory\n")
498
if 'mem_dump' in debug.debug_flags:
499
_dump_memory_usage(err_file)
501
err_file.write("Use -Dmem_dump to dump memory to a file.\n")
502
return errors.EXIT_ERROR
503
elif isinstance(exc_object, ImportError) \
504
and str(exc_object).startswith("No module named "):
505
report_user_error(exc_info, err_file,
506
'You may need to install this Python library separately.')
507
return errors.EXIT_ERROR
508
elif not getattr(exc_object, 'internal_error', True):
509
report_user_error(exc_info, err_file)
510
return errors.EXIT_ERROR
511
elif osutils.is_environment_error(exc_object):
512
if getattr(exc_object, 'errno', None) == errno.EPIPE:
513
err_file.write("brz: broken pipe\n")
514
return errors.EXIT_ERROR
515
# Might be nice to catch all of these and show them as something more
516
# specific, but there are too many cases at the moment.
517
report_user_error(exc_info, err_file)
518
return errors.EXIT_ERROR
520
report_bug(exc_info, err_file)
521
return errors.EXIT_INTERNAL_ERROR
524
def print_exception(exc_info, err_file):
525
exc_type, exc_object, exc_tb = exc_info
526
err_file.write("brz: ERROR: %s: %s\n" % (
527
_qualified_exception_name(exc_type), exc_object))
529
traceback.print_exception(exc_type, exc_object, exc_tb, file=err_file)
532
# TODO: Should these be specially encoding the output?
533
def report_user_error(exc_info, err_file, advice=None):
534
"""Report to err_file an error that's not an internal error.
536
These don't get a traceback unless -Derror was given.
538
:param exc_info: 3-tuple from sys.exc_info()
539
:param advice: Extra advice to the user to be printed following the
542
err_file.write("brz: ERROR: %s\n" % (exc_info[1],))
544
err_file.write("%s\n" % advice)
547
def report_bug(exc_info, err_file):
548
"""Report an exception that probably indicates a bug in brz"""
549
from breezy.crash import report_bug
550
report_bug(exc_info, err_file)
553
def _flush_stdout_stderr():
554
# called from the breezy library finalizer returned by breezy.initialize()
558
except ValueError as e:
559
# On Windows, I get ValueError calling stdout.flush() on a closed
564
if e.errno in [errno.EINVAL, errno.EPIPE]:
571
# called from the breezy library finalizer returned by breezy.initialize()
577
class EncodedStreamHandler(logging.Handler):
578
"""Robustly write logging events to a stream using the specified encoding
580
Messages are expected to be formatted to unicode, but UTF-8 byte strings
581
are also accepted. An error during formatting or a str message in another
582
encoding will be quitely noted as an error in the Bazaar log file.
584
The stream is not closed so sys.stdout or sys.stderr may be passed.
587
def __init__(self, stream, encoding=None, errors='strict', level=0):
588
logging.Handler.__init__(self, level)
591
encoding = getattr(stream, "encoding", "ascii")
592
self.encoding = encoding
596
flush = getattr(self.stream, "flush", None)
597
if flush is not None:
600
def emit(self, record):
602
if not isinstance(record.msg, text_type):
603
msg = record.msg.decode("utf-8")
606
line = self.format(record)
607
if not isinstance(line, text_type):
608
line = line.decode("utf-8")
609
self.stream.write(line.encode(self.encoding, self.errors) + b"\n")
611
log_exception_quietly()
612
# Try saving the details that would have been logged in some form
613
msg = args = "<Unformattable>"
615
msg = repr(record.msg).encode("ascii", "backslashescape")
616
args = repr(record.args).encode("ascii", "backslashescape")
619
# Using mutter() bypasses the logging module and writes directly
620
# to the file so there's no danger of getting into a loop here.
621
mutter("Logging record unformattable: %s %% %s", msg, args)
624
class Config(object):
625
"""Configuration of message tracing in breezy.
627
This implements the context manager protocol and should manage any global
628
variables still used. The default config used is DefaultConfig, but
629
embedded uses of breezy may wish to use a custom manager.
633
return self # This is bound to the 'as' clause in a with statement.
635
def __exit__(self, exc_type, exc_val, exc_tb):
636
return False # propogate exceptions.
639
class DefaultConfig(Config):
640
"""A default configuration for tracing of messages in breezy.
642
This implements the context manager protocol.
646
self._original_filename = _brz_log_filename
647
self._original_state = enable_default_logging()
648
return self # This is bound to the 'as' clause in a with statement.
650
def __exit__(self, exc_type, exc_val, exc_tb):
651
pop_log_file(self._original_state)
652
global _brz_log_filename
653
_brz_log_filename = self._original_filename
654
return False # propogate exceptions.
added
removed
breezy/trace.py
