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
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
|
import sys
import json
import zipfile
import multiprocessing.pool
from collections import Counter
from confluent_kafka import Consumer, Producer, KafkaException
from .misc import parse_cdx_line
class SandcrawlerWorker(object):
"""
Base class for sandcrawler workers.
Usually these get "pushed" into by a RecordPusher. Output goes to another
worker (pipeline-style), or defaults to stdout.
"""
def __init__(self):
self.counts = Counter()
self.sink = None
# TODO: self.counters
def push_record(self, task):
self.counts['total'] += 1
result = self.process(task)
if not result:
self.counts['failed'] += 1
return
elif type(result) == dict and 'status' in result and len(result['status']) < 32:
self.counts[result['status']] += 1
if self.sink:
self.sink.push_record(result)
self.counts['pushed'] += 1
else:
print(json.dumps(result))
return result
def push_batch(self, tasks):
results = []
for task in tasks:
results.append(self.push_record(task))
return results
def finish(self):
if self.sink:
self.sink.finish()
print("Worker: {}".format(self.counts), file=sys.stderr)
return self.counts
class MultiprocessWrapper(SandcrawlerWorker):
def __init__(self, worker, sink, jobs=None):
self.counts = Counter()
self.worker = worker
self.sink = sink
self.pool = multiprocessing.pool.Pool(jobs)
def push_batch(self, tasks):
self.counts['total'] += len(tasks)
print("... processing batch of: {}".format(len(tasks)), file=sys.stderr)
results = self.pool.map(self.worker.process, tasks)
for result in results:
if not result:
self.counts['failed'] += 1
return
elif type(result) == dict and 'status' in result and len(result['status']) < 32:
self.counts[result['status']] += 1
if self.sink:
self.sink.push_record(result)
self.counts['pushed'] += 1
else:
print(json.dumps(result))
return results
def finish(self):
self.pool.terminate()
if self.sink:
self.sink.finish()
worker_counts = self.worker.finish()
print("Multiprocessing: {}".format(self.counts), file=sys.stderr)
return worker_counts
class BlackholeSink(SandcrawlerWorker):
"""
Dummy SandcrawlerWorker. That doesn't do or process anything.
Useful for tests.
"""
def push_record(self, task):
return
def push_batch(self, tasks):
return
class KafkaSink(SandcrawlerWorker):
def __init__(self, kafka_hosts, produce_topic, **kwargs):
self.sink = None
self.counts = Counter()
self.produce_topic = produce_topic
self.kafka_hosts = kafka_hosts
config = self.producer_config({
'bootstrap.servers': kafka_hosts,
'message.max.bytes': 20000000, # ~20 MBytes; broker is ~50 MBytes
'api.version.request': True,
'api.version.fallback.ms': 0,
})
self.producer = Producer(config)
@staticmethod
def _fail_fast(err, msg):
if err is not None:
print("Kafka producer delivery error: {}".format(err), file=sys.stderr)
print("Bailing out...", file=sys.stderr)
# TODO: should it be sys.exit(-1)?
raise KafkaException(err)
def producer_config(self, kafka_config):
config = kafka_config.copy()
config.update({
'delivery.report.only.error': True,
'default.topic.config': {
'request.required.acks': -1, # all brokers must confirm
}
})
return config
def push_record(self, msg, key=None):
self.counts['total'] += 1
if type(msg) == dict:
if not key and 'key' in msg:
key = msg['key']
msg = json.dumps(msg)
if type(msg) == str:
msg = msg.encode('utf-8')
assert type(msg) == bytes
self.producer.produce(
self.produce_topic,
msg,
key=key,
on_delivery=self._fail_fast)
self.counts['produced'] += 1
# TODO: check for errors etc. is this necessary?
self.producer.poll(0)
def push_batch(self, msgs):
for m in msgs:
self.push_record(m)
def finish(self):
self.producer.flush()
return self.counts
class KafkaGrobidSink(KafkaSink):
"""
Variant of KafkaSink for large documents. Used for, eg, GROBID output.
"""
def producer_config(self, kafka_config):
config = kafka_config.copy()
config.update({
'compression.codec': 'gzip',
'retry.backoff.ms': 250,
'linger.ms': 5000,
'batch.num.messages': 50,
'delivery.report.only.error': True,
'default.topic.config': {
'request.required.acks': -1, # all brokers must confirm
}
})
return config
class RecordPusher:
"""
Base class for different record sources to be pushed into workers. Pretty
trivial interface, just wraps an importer and pushes records in to it.
"""
def __init__(self, worker, **kwargs):
self.counts = Counter()
self.worker = worker
def run(self):
"""
This will look something like:
for line in sys.stdin:
record = json.loads(line)
self.worker.push_record(record)
print(self.worker.finish())
"""
raise NotImplementedError
class JsonLinePusher(RecordPusher):
def __init__(self, worker, json_file, **kwargs):
self.counts = Counter()
self.worker = worker
self.json_file = json_file
self.batch_size = kwargs.get('batch_size', None)
if self.batch_size in (0, 1):
self.batch_size = None
def run(self):
batch = []
for line in self.json_file:
if not line:
continue
self.counts['total'] += 1
try:
record = json.loads(line)
except json.decoder.JSONDecodeError:
self.counts['error-json-decode'] += 1
continue
if self.batch_size:
batch.append(record)
if len(batch) >= self.batch_size:
self.worker.push_batch(batch)
self.counts['pushed'] += len(batch)
batch = []
else:
self.worker.push_record(record)
self.counts['pushed'] += 1
if self.batch_size and batch:
self.worker.push_batch(batch)
self.counts['pushed'] += len(batch)
batch = []
worker_counts = self.worker.finish()
print("JSON lines pushed: {}".format(self.counts), file=sys.stderr)
return self.counts
class CdxLinePusher(RecordPusher):
def __init__(self, worker, cdx_file, **kwargs):
self.counts = Counter()
self.worker = worker
self.cdx_file = cdx_file
self.filter_http_statuses = kwargs.get('filter_http_statuses', None)
self.filter_mimetypes = kwargs.get('filter_mimetypes', None)
self.allow_octet_stream = kwargs.get('allow_octet_stream', False)
self.batch_size = kwargs.get('batch_size', None)
if self.batch_size in (0, 1):
self.batch_size = None
def run(self):
batch = []
for line in self.cdx_file:
if not line:
continue
self.counts['total'] += 1
record = parse_cdx_line(line, normalize=True)
if not record:
self.counts['skip-parse'] += 1
continue
if self.filter_http_statuses and record['http_status'] not in self.filter_http_statuses:
self.counts['skip-http_status'] += 1
continue
if self.filter_mimetypes and record['mimetype'] not in self.filter_mimetypes:
self.counts['skip-mimetype'] += 1
continue
if self.batch_size:
batch.append(record)
if len(batch) > self.batch_size:
self.worker.push_batch(batch)
self.counts['pushed'] += len(batch)
batch = []
else:
self.worker.push_record(record)
self.counts['pushed'] += 1
if self.batch_size and batch:
self.worker.push_batch(batch)
self.counts['pushed'] += len(batch)
batch = []
worker_counts = self.worker.finish()
print("CDX lines pushed: {}".format(self.counts), file=sys.stderr)
return self.counts
class ZipfilePusher(RecordPusher):
def __init__(self, worker, zipfile_path, **kwargs):
self.counts = Counter()
self.worker = worker
self.filter_suffix = ".pdf"
self.zipfile_path = zipfile_path
def run(self):
with zipfile.ZipFile(self.zipfile_path, 'r') as archive:
for zipinfo in archive.infolist():
if not zipinfo.filename.endswith(self.filter_suffix):
continue
self.counts['total'] += 1
# NB doesn't really extract the file, just gives you a stream (file-like-object) for reading it
flo = archive.open(zipinfo, 'r')
data = flo.read(2**32)
flo.close()
self.worker.push_record(data)
self.counts['pushed'] += 1
worker_counts = self.worker.finish()
print("ZIP PDFs pushed: {}".format(self.counts), file=sys.stderr)
return self.counts
class KafkaJsonPusher(RecordPusher):
def __init__(self, worker, kafka_hosts, consume_topic, group, **kwargs):
self.counts = Counter()
self.worker = worker
self.consumer = make_kafka_consumer(
kafka_hosts,
consume_topic,
group,
)
self.push_batches = kwargs.get('push_batches', False)
self.poll_interval = kwargs.get('poll_interval', 5.0)
self.batch_size = kwargs.get('batch_size', 100)
if self.batch_size in (0, 1):
self.batch_size = 1
self.batch_worker = kwargs.get('batch_worker', False)
def run(self):
while True:
# TODO: this is batch-oriented, because underlying worker is
# often batch-oriented, but this doesn't confirm that entire batch
# has been pushed to fatcat before commiting offset. Eg, consider
# case where there there is one update and thousands of creates;
# update would be lingering in worker, and if worker crashed
# never created. Not great.
batch = self.consumer.consume(
num_messages=self.batch_size,
timeout=self.poll_interval)
print("... got {} kafka messages ({}sec poll interval)".format(
len(batch), self.poll_interval),
file=sys.stderr)
if not batch:
# TODO: could have some larger timeout here and
# self.worker.finish() if it's been more than, eg, a couple
# minutes
continue
# first check errors on entire batch...
for msg in batch:
if msg.error():
raise KafkaException(msg.error())
# ... then process
if self.push_batches:
self.counts['total'] += len(batch)
records = [json.loads(msg.value().decode('utf-8')) for msg in batch]
self.worker.push_batch(records)
self.counts['pushed'] += len(batch)
print("Import counts: {}".format(self.worker.counts), file=sys.stderr)
else:
for msg in batch:
self.counts['total'] += 1
record = json.loads(msg.value().decode('utf-8'))
self.worker.push_record(record)
self.counts['pushed'] += 1
if self.counts['total'] % 500 == 0:
print("Import counts: {}".format(self.worker.counts), file=sys.stderr)
for msg in batch:
# locally store offsets of processed messages; will be
# auto-commited by librdkafka from this "stored" value
self.consumer.store_offsets(message=msg)
# TODO: should catch UNIX signals (HUP?) to shutdown cleanly, and/or
# commit the current batch if it has been lingering
worker_counts = self.worker.finish()
print("KafkaJson lines pushed: {}".format(self.counts), file=sys.stderr)
self.consumer.close()
return self.counts
def make_kafka_consumer(hosts, consume_topic, group):
topic_name = consume_topic
def fail_fast(err, partitions):
if err is not None:
print("Kafka consumer commit error: {}".format(err), file=sys.stderr)
print("Bailing out...", file=sys.stderr)
# TODO: should it be sys.exit(-1)?
raise KafkaException(err)
for p in partitions:
# check for partition-specific commit errors
if p.error:
print("Kafka consumer commit error: {}".format(p.error), file=sys.stderr)
print("Bailing out...", file=sys.stderr)
# TODO: should it be sys.exit(-1)?
raise KafkaException(err)
#print("Kafka consumer commit successful")
pass
# previously, using pykafka
#auto_commit_enable=True,
#auto_commit_interval_ms=30000, # 30 seconds
conf = {
'bootstrap.servers': hosts,
'group.id': group,
'on_commit': fail_fast,
# messages don't have offset marked as stored until processed,
# but we do auto-commit stored offsets to broker
'enable.auto.offset.store': False,
'enable.auto.commit': True,
# user code timeout; if no poll after this long, assume user code
# hung and rebalance (default: 6min)
'max.poll.interval.ms': 360000,
'default.topic.config': {
'auto.offset.reset': 'latest',
},
}
def on_rebalance(consumer, partitions):
for p in partitions:
if p.error:
raise KafkaException(p.error)
print("Kafka partitions rebalanced: {} / {}".format(
consumer, partitions),
file=sys.stderr)
consumer = Consumer(conf)
# NOTE: it's actually important that topic_name *not* be bytes (UTF-8
# encoded)
consumer.subscribe([topic_name],
on_assign=on_rebalance,
on_revoke=on_rebalance,
)
print("Consuming from kafka topic {}, group {}".format(topic_name, group), file=sys.stderr)
return consumer
|