1
# Copyright (C) 2007 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Transport decorator that logs transport operations to .bzr.log."""
20
# see also the transportstats plugin, which gives you some summary information
21
# in a machine-readable dump
28
from bzrlib.trace import mutter
29
from bzrlib.transport.decorator import (
32
from bzrlib.transport.trace import (
34
TransportTraceDecorator,
40
class TransportLogDecorator(TransportDecorator):
41
"""Decorator for Transports that logs interesting operations to .bzr.log.
43
In general we want to log things that usually take a network round trip
46
Not all operations are logged yet.
49
def __init__(self, *args, **kw):
50
super(TransportLogDecorator, self).__init__(*args, **kw)
51
def _make_hook(hookname):
52
def _hook(relpath, *args, **kw):
53
return self._log_and_call(hookname, relpath, *args, **kw)
65
'put_bytes', 'put_bytes_non_atomic', 'put_file put_file_non_atomic',
66
'list_dir', 'lock_read', 'lock_write',
67
'readv', 'rename', 'rmdir',
71
setattr(self, methodname, _make_hook(methodname))
74
def _get_url_prefix(self):
77
def iter_files_recursive(self):
78
# needs special handling because it does not have a relpath parameter
80
% ('iter_files_recursive', self._decorated.base))
81
return self._call_and_log_result('iter_files_recursive', (), {})
83
def _log_and_call(self, methodname, relpath, *args, **kwargs):
85
kwargs_str = dict(kwargs)
89
% (methodname, self._decorated.abspath(relpath),
90
self._shorten(self._strip_tuple_parens(args)),
92
return self._call_and_log_result(methodname, (relpath,) + args, kwargs)
94
def _call_and_log_result(self, methodname, args, kwargs):
97
result = getattr(self._decorated, methodname)(*args, **kwargs)
100
mutter(" %.03fs" % (time.time() - before))
102
return self._show_result(before, methodname, result)
104
def _show_result(self, before, methodname, result):
106
if isinstance(result, types.GeneratorType):
107
# eagerly pull in all the contents, so that we can measure how
108
# long it takes to get them. this does make the behaviour a bit
109
# different, but we hope not noticably so
110
result = list(result)
111
if isinstance(result, (cStringIO.OutputType, StringIO.StringIO)):
112
val = repr(result.getvalue())
113
result_len = len(val)
114
shown_result = "%s(%s) (%d bytes)" % (result.__class__.__name__,
115
self._shorten(val), result_len)
116
elif methodname == 'readv':
117
num_hunks = len(result)
118
total_bytes = sum((len(d) for o,d in result))
119
shown_result = "readv response, %d hunks, %d total bytes" % (
120
num_hunks, total_bytes)
121
result_len = total_bytes
123
shown_result = self._shorten(self._strip_tuple_parens(result))
124
mutter(" --> %s" % shown_result)
125
# XXX: the time may be wrong when e.g. a generator object is returned from
126
# an http readv, if the object is returned before the bulk data
128
elapsed = time.time() - before
129
if result_len and elapsed > 0:
130
# this is the rate of higher-level data, not the raw network speed
131
mutter(" %9.03fs %8dkB/s" % (elapsed, result_len/elapsed/1024))
133
mutter(" %9.03fs" % (elapsed))
136
def _shorten(self, x):
141
def _strip_tuple_parens(self, t):
143
if t[0] == '(' and t[-1] == ')':
148
class LogDecoratorServer(DecoratorServer):
149
"""Server for testing."""
151
def get_decorator_class(self):
152
return TransportLogDecorator
155
def get_test_permutations():
156
"""Return the permutations to be used in testing."""
157
return [(TransportLogDecorator, LogDecoratorServer)]
added
removed
bzrlib/transport/log.py
