1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
|
#!/usr/bin/python3
#
# repeatedly snapshot heap profiles for one or more algod
#
# usage:
# mkdir -p /tmp/heaps
# python3 test/scripts/heapWatch.py -o /tmp/heaps --period 60s private_network_root/*
import argparse
import base64
import configparser
import fnmatch
import json
import logging
import os
import re
import signal
import shutil
import subprocess
import sys
import time
import urllib.request
# pip install py-algorand-sdk
import algosdk
from algosdk.encoding import msgpack
import algosdk.v2client
import algosdk.v2client.algod
logger = logging.getLogger(__name__)
def read_algod_dir(algorand_data):
with open(os.path.join(algorand_data, 'algod.net')) as fin:
net = fin.read().strip()
with open(os.path.join(algorand_data, 'algod.token')) as fin:
token = fin.read().strip()
with open(os.path.join(algorand_data, 'algod.admin.token')) as fin:
admin_token = fin.read().strip()
return net, token, admin_token
# data from /debug/pprof/* is already gzipped
# curl -o /tmp/algod.pprof.heap "http://`cat ${ALGORAND_DATA}/algod.net`/urlAuth/`cat ${ALGORAND_DATA}/algod.admin.token`/debug/pprof/heap"
# both reports can be generated from one heap profile snapshot
# go tool pprof -sample_index=inuse_space -svg -output /tmp/algod.heap.svg /tmp/algod.pprof.heap
# go tool pprof -sample_index=alloc_space -svg -output /tmp/algod.alloc.svg /tmp/algod.pprof.heap
## curl -o /tmp/algod.pprof.allocs "http://`cat ${ALGORAND_DATA}/algod.net`/urlAuth/`cat ${ALGORAND_DATA}/algod.admin.token`/debug/pprof/allocs"
# go tool pprof -svg -output /tmp/algod.allocs.svg /tmp/algod.pprof.allocs
# http://localhost:6060/debug/pprof/allocs?debug=1
# -inuse_space Same as -sample_index=inuse_space
# -inuse_objects Same as -sample_index=inuse_objects
# -alloc_space Same as -sample_index=alloc_space
# -alloc_objects Same as -sample_index=alloc_objects
graceful_stop = False
def do_graceful_stop(signum, frame):
global graceful_stop
if graceful_stop:
sys.stderr.write("second signal, quitting\n")
sys.exit(1)
sys.stderr.write("graceful stop...\n")
graceful_stop = True
signal.signal(signal.SIGTERM, do_graceful_stop)
signal.signal(signal.SIGINT, do_graceful_stop)
def jsonable(ob):
if isinstance(ob, bytes):
return base64.b64encode(ob).decode()
if isinstance(ob, list):
return [jsonable(x) for x in ob]
if isinstance(ob, dict):
return {jsonable(k):jsonable(v) for k,v in ob.items()}
return ob
class algodDir:
def __init__(self, path, net=None, token=None, admin_token=None):
self.path = path
self.nick = os.path.basename(self.path)
if net is None:
net, token, admin_token = read_algod_dir(self.path)
self.net = net
self.token = token
self.admin_token = admin_token
self.headers = {}
self._pid = None
self._algod = None
def pid(self):
if self._pid is None:
with open(os.path.join(self.path, 'algod.pid')) as fin:
self._pid = int(fin.read())
return self._pid
def algod(self):
if self._algod is None:
net = self.net
if not net.startswith('http'):
net = 'http://' + net
self._algod = algosdk.v2client.algod.AlgodClient(self.token, net, self.headers)
return self._algod
def get_pprof_snapshot(self, name, snapshot_name=None, outdir=None):
url = 'http://' + self.net + '/urlAuth/' + self.admin_token + '/debug/pprof/' + name
response = urllib.request.urlopen(urllib.request.Request(url, headers=self.headers))
if response.code != 200:
logger.error('could not fetch %s from %s via %r', name, self.path. url)
return
blob = response.read()
if snapshot_name is None:
snapshot_name = time.strftime('%Y%m%d_%H%M%S', time.gmtime())
outpath = os.path.join(outdir or '.', self.nick + '.' + snapshot_name + '.' + name)
with open(outpath, 'wb') as fout:
fout.write(blob)
logger.debug('%s -> %s', self.nick, outpath)
return outpath
def get_heap_snapshot(self, snapshot_name=None, outdir=None):
return self.get_pprof_snapshot('heap', snapshot_name, outdir)
def get_goroutine_snapshot(self, snapshot_name=None, outdir=None):
return self.get_pprof_snapshot('goroutine', snapshot_name, outdir)
def get_metrics(self, snapshot_name=None, outdir=None):
url = 'http://' + self.net + '/metrics'
try:
response = urllib.request.urlopen(urllib.request.Request(url, headers=self.headers))
if response.code != 200:
logger.error('could not fetch %s from %s via %r', snapshot_name, self.path. url)
return
blob = response.read()
except Exception as e:
logger.error('could not fetch %s from %s via %r: %s', snapshot_name, self.path, url, e)
return
outpath = os.path.join(outdir or '.', self.nick + '.' + snapshot_name + '.metrics')
with open(outpath, 'wb') as fout:
fout.write(blob)
logger.debug('%s -> %s', self.nick, outpath)
def get_blockinfo(self, snapshot_name=None, outdir=None):
try:
algod = self.algod()
status = algod.status()
except Exception as e:
logger.error('could not get blockinfo from %s: %s', self.net, e)
self._algod = None
return
bi = msgpack.loads(algod.block_info(status['last-round'], response_format='msgpack'), strict_map_key=False)
if snapshot_name is None:
snapshot_name = time.strftime('%Y%m%d_%H%M%S', time.gmtime())
outpath = os.path.join(outdir or '.', self.nick + '.' + snapshot_name + '.blockinfo.json')
bi['block'].pop('txns', None)
bi['block'].pop('cert', None)
with open(outpath, 'wt') as fout:
json.dump(jsonable(bi), fout)
return bi
#txncount = bi['block']['tc']
def psHeap(self):
# return rss, vsz (in kilobytes)
# ps -o rss,vsz $(cat ${ALGORAND_DATA}/algod.pid)
subp = subprocess.Popen(['ps', '-o', 'rss,vsz', str(self.pid())], stdout=subprocess.PIPE)
try:
outs, errs = subp.communicate(timeout=2)
for line in outs.decode().splitlines():
try:
rss,vsz = [int(x) for x in line.strip().split()]
return rss,vsz
except:
pass
except:
return None, None
class watcher:
def __init__(self, args):
self.args = args
self.prevsnapshots = {}
self.they = []
self.netseen = set()
os.makedirs(self.args.out, exist_ok=True)
if not args.data_dirs and os.path.exists(args.tf_inventory):
cp = configparser.ConfigParser(allow_no_value=True)
cp.read(args.tf_inventory)
shutil.copy2(args.tf_inventory, self.args.out)
for role in args.tf_roles.split(','):
role_name = 'role_' + role
for net in cp[role_name].keys():
logger.debug('addnet role %s %s', role, net)
self._addnet(net)
for nre in args.tf_name_re:
namere = re.compile(nre)
for k,v in cp.items():
if not namere.match(k):
continue
for net in v.keys():
logger.debug('addnet re %s %s', nre, net)
self._addnet(net)
for path in args.data_dirs:
if not os.path.isdir(path):
continue
if os.path.exists(os.path.join(path, 'algod.net')):
try:
ad = algodDir(path)
self.they.append(ad)
except:
logger.error('bad algod: %r', path, exc_info=True)
else:
logger.debug('not a datadir: %r', path)
logger.debug('data dirs: %r', self.they)
def _addnet(self, net):
if net in self.netseen:
return
self.netseen.add(net)
net = net + ':8580'
try:
ad = algodDir(net, net=net, token=self.args.token, admin_token=self.args.admin_token)
self.they.append(ad)
except:
logger.error('bad algod: %r', net, exc_info=True)
def do_snap(self, now):
snapshot_name = time.strftime('%Y%m%d_%H%M%S', time.gmtime(now))
snapshot_isotime = time.strftime('%Y-%m-%d %H:%M:%S', time.gmtime(now))
logger.debug('begin snapshot %s', snapshot_name)
psheaps = {}
newsnapshots = {}
if self.args.heaps:
for ad in self.they:
snappath = ad.get_heap_snapshot(snapshot_name, outdir=self.args.out)
newsnapshots[ad.path] = snappath
rss, vsz = ad.psHeap()
if rss and vsz:
psheaps[ad.nick] = (rss, vsz)
for nick, rssvsz in psheaps.items():
rss, vsz = rssvsz
with open(os.path.join(self.args.out, nick + '.heap.csv'), 'at') as fout:
fout.write('{},{},{},{}\n'.format(snapshot_name,snapshot_isotime,rss, vsz))
if self.args.goroutine:
for ad in self.they:
ad.get_goroutine_snapshot(snapshot_name, outdir=self.args.out)
if self.args.metrics:
for ad in self.they:
ad.get_metrics(snapshot_name, outdir=self.args.out)
if self.args.blockinfo:
for ad in self.they:
ad.get_blockinfo(snapshot_name, outdir=self.args.out)
if self.args.svg:
logger.debug('snapped, processing...')
# make absolute and differential plots
for path, snappath in newsnapshots.items():
subprocess.call(['go', 'tool', 'pprof', '-sample_index=inuse_space', '-svg', '-output', snappath + '.inuse.svg', snappath])
subprocess.call(['go', 'tool', 'pprof', '-sample_index=alloc_space', '-svg', '-output', snappath + '.alloc.svg', snappath])
prev = self.prevsnapshots.get(path)
if prev:
subprocess.call(['go', 'tool', 'pprof', '-sample_index=inuse_space', '-svg', '-output', snappath + '.inuse_diff.svg', '-base='+prev, snappath])
subprocess.call(['go', 'tool', 'pprof', '-sample_index=alloc_space', '-svg', '-output', snappath + '.alloc_diff.svg', '-diff_base='+prev, snappath])
self.prevsnapshots = newsnapshots
def main():
ap = argparse.ArgumentParser()
ap.add_argument('data_dirs', nargs='*', help='list paths to algorand datadirs to grab heap profile from')
ap.add_argument('--no-heap', dest='heaps', default=True, action='store_false', help='disable heap snapshot capture')
ap.add_argument('--goroutine', default=False, action='store_true', help='also capture goroutine profile')
ap.add_argument('--metrics', default=False, action='store_true', help='also capture /metrics counts')
ap.add_argument('--blockinfo', default=False, action='store_true', help='also capture block header info')
ap.add_argument('--period', default=None, help='seconds between automatically capturing')
ap.add_argument('--runtime', default=None, help='(\d+)[hm]? time in hour/minute (default second) to gather info then exit')
ap.add_argument('--tf-inventory', default='terraform-inventory.host', help='terraform inventory file to use if no data_dirs specified')
ap.add_argument('--token', default='', help='default algod api token to use')
ap.add_argument('--admin-token', default='', help='default algod admin-api token to use')
ap.add_argument('--tf-roles', default='relay', help='comma separated list of terraform roles to follow')
ap.add_argument('--tf-name-re', action='append', default=[], help='regexp to match terraform node names, may be repeated')
ap.add_argument('--no-svg', dest='svg', default=True, action='store_false', help='do not automatically run `go tool pprof` to generate svg from collected data')
ap.add_argument('-o', '--out', default=None, help='directory to write to')
ap.add_argument('--verbose', default=False, action='store_true')
args = ap.parse_args()
if args.verbose:
logging.basicConfig(level=logging.DEBUG)
else:
logging.basicConfig(level=logging.INFO)
for nre in args.tf_name_re:
try:
# do re.compile just to check
re.compile(nre)
except Exception as e:
sys.stderr.write('bad --tf-name-re %r: %s', nre, e)
return 1
app = watcher(args)
# get a first snapshot immediately
start = time.time()
now = start
app.do_snap(now)
endtime = None
if args.runtime:
rts = args.runtime
if rts.endswith('h'):
mult = 3600
rts = rts[:-1]
elif rts.endswith('m'):
mult = 60
rts = rts[:-1]
else:
mult = 1
endtime = (float(rts) * mult) + start
if args.period:
lastc = args.period.lower()[-1:]
if lastc == 's':
periodSecs = int(args.period[:-1])
elif lastc == 'm':
periodSecs = int(args.period[:-1]) * 60
elif lastc == 'h':
periodSecs = int(args.period[:-1]) * 3600
else:
periodSecs = int(args.period)
periodi = 1
nextt = start + (periodi * periodSecs)
while not graceful_stop:
while nextt < now:
nextt = start + (periodi * periodSecs)
while now < nextt - (periodSecs * 0.05):
logger.debug('sleep %f', nextt - now)
time.sleep(nextt - now)
if graceful_stop:
return
now = time.time()
periodi += 1
nextt += periodSecs
app.do_snap(now)
if (endtime is not None) and (now > endtime):
return
return 0
if __name__ == '__main__':
sys.exit(main())
|