-
Notifications
You must be signed in to change notification settings - Fork 107
/
MSOutput.py
926 lines (839 loc) · 44.4 KB
/
MSOutput.py
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
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
"""
File : MSOtput.py
Description: MSOutput.py class provides the whole logic behind
the Output data placement in WMCore MicroServices.
"""
# futures
from __future__ import division, print_function
# system modules
from http.client import HTTPException
from pymongo import IndexModel, ReturnDocument, errors
from pprint import pformat
from threading import current_thread
from retry import retry
# WMCore modules
from WMCore.MicroService.DataStructs.DefaultStructs import OUTPUT_REPORT
from WMCore.MicroService.Unified.MSCore import MSCore
from WMCore.MicroService.Unified.Common import gigaBytes
from WMCore.Services.CRIC.CRIC import CRIC
from Utils.EmailAlert import EmailAlert
from Utils.Pipeline import Pipeline, Functor
from WMCore.Database.MongoDB import MongoDB
from WMCore.MicroService.DataStructs.MSOutputTemplate import MSOutputTemplate
from WMCore.WMException import WMException
class MSOutputException(WMException):
"""
General Exception Class for MSOutput Module in WMCore MicroServices
"""
def __init__(self, message):
self.myMessage = "MSOtputException: %s" % message
super(MSOutputException, self).__init__(self.myMessage)
class EmptyResultError(MSOutputException):
"""
A MSOutputException signalling an empty result from database query.
"""
def __init__(self, message=None):
if message:
self.myMessage = "EmptyResultError: %s"
else:
self.myMessage = "EmptyResultError."
super(EmptyResultError, self).__init__(self.myMessage)
class UnsupportedError(MSOutputException):
"""
A MSOutputException signalling an unsupported mode for a function or method.
"""
def __init__(self, message=None):
if message:
self.myMessage = "UnsupportedError: %s"
else:
self.myMessage = "UnsupportedError."
super(UnsupportedError, self).__init__(self.myMessage)
class MSOutput(MSCore):
"""
MSOutput.py class provides the whole logic behind the Output data placement
in MicroServices.
"""
def __init__(self, msConfig, mode, reqCache, logger=None):
"""
Runs the basic setup and initialization for the MSOutput module
:microConfig: microservice configuration
:mode: MSOutput Run mode:
- MSOutputConsumer:
Reads The workflow and transfer subscriptions from MongoDB and
makes transfer subscriptions.
- MSOutputProducer:
Fetches Workflows in a given status from Reqmgr2 then creates
and uploads the documents to MongoDB.
"""
super(MSOutput, self).__init__(msConfig, logger=logger)
self.mode = mode
self.msConfig.setdefault("limitRequestsPerCycle", 500)
self.msConfig.setdefault("enableDataPlacement", False)
self.msConfig.setdefault("enableRelValCustodial", False)
self.msConfig.setdefault("excludeDataTier", [])
self.msConfig.setdefault("rucioAccount", 'wmcore_transferor')
self.msConfig.setdefault("rucioRSEAttribute", 'ddm_quota')
self.msConfig.setdefault("rucioDiskRuleWeight", 'ddm_quota')
self.msConfig.setdefault("rucioTapeExpression", 'rse_type=TAPE\cms_type=test')
self.msConfig.setdefault("mongoDBUrl", 'mongodb://localhost')
self.msConfig.setdefault("mongoDBPort", 8230)
self.msConfig.setdefault("sendNotification", False)
self.uConfig = {}
self.emailAlert = EmailAlert(self.msConfig)
self.cric = CRIC(logger=self.logger)
self.uConfig = {}
self.campaigns = {}
self.psn2pnnMap = {}
# cache to store request names shared between the Producer and Consumer threads
self.requestNamesCached = reqCache
self.tapeStatus = dict()
for endpoint, quota in self.msConfig['tapePledges'].viewitems():
self.tapeStatus[endpoint] = dict(quota=quota, usage=0, remaining=0)
msOutIndex = IndexModel('RequestName', unique=True)
msOutDBConfig = {
'database': 'msOutDB',
'server': self.msConfig['mongoDBUrl'],
'port': self.msConfig['mongoDBPort'],
'logger': self.logger,
'create': True,
'collections': [
('msOutRelValColl', msOutIndex),
('msOutNonRelValColl', msOutIndex)]}
self.msOutDB = MongoDB(**msOutDBConfig).msOutDB
self.msOutRelValColl = self.msOutDB['msOutRelValColl']
self.msOutNonRelValColl = self.msOutDB['msOutNonRelValColl']
@retry(tries=3, delay=2, jitter=2)
def updateCaches(self):
"""
Fetch some data required for the output logic, e.g.:
* unified configuration
"""
self.logger.info("%s: Updating local cache information.", self.currThreadIdent)
self.logger.info("%s: Request names cache size: %s", self.currThreadIdent, len(self.requestNamesCached))
self.uConfig = self.unifiedConfig()
campaigns = self.reqmgrAux.getCampaignConfig("ALL_DOCS")
self.psn2pnnMap = self.cric.PSNtoPNNMap()
if not self.uConfig:
raise RuntimeWarning("Failed to fetch the unified configuration")
elif not campaigns:
raise RuntimeWarning("Failed to fetch the campaign configurations")
elif not self.psn2pnnMap:
raise RuntimeWarning("Failed to fetch PSN x PNN map from CRIC")
else:
# let's make campaign look-up easier and more efficient
self.campaigns = {}
for camp in campaigns:
self.campaigns[camp['CampaignName']] = camp
def execute(self, reqStatus):
"""
Executes the whole output data placement logic. However, updating the
local caches is a requirement to proceed with the rest of the execution.
:return: summary report for an execution cycle
"""
summary = dict(OUTPUT_REPORT)
self.currThread = current_thread()
self.currThreadIdent = self.currThread.name
self.updateReportDict(summary, "thread_id", self.currThreadIdent)
try:
self.updateCaches()
except RuntimeWarning as ex:
msg = "{}: All retries exhausted! Last error was: '{}'".format(self.currThreadIdent,
str(ex))
msg += "\nRetrying to update caches again in the next cycle."
self.logger.error(msg)
self.updateReportDict(summary, "error", msg)
return summary
except Exception as ex:
msg = "{}: Unknown exception updating caches. ".format(self.currThreadIdent)
msg += "Error: {}".format(str(ex))
self.logger.exception(msg)
self.updateReportDict(summary, "error", msg)
return summary
if self.mode == 'MSOutputProducer':
self._executeProducer(reqStatus, summary)
elif self.mode == 'MSOutputConsumer':
self._executeConsumer(summary)
else:
msg = "MSOutput is running in unsupported mode: %s\n" % self.mode
msg += "Skipping the current run!"
self.logger.warning(msg)
self.updateReportDict(summary, "error", msg)
return summary
def _executeProducer(self, reqStatus, summary):
"""
The function to update caches and to execute the Producer function itself
:param summary: dictionary with some high level summary for this cycle execution
"""
msg = "{}: MSOutput is running in mode: {}".format(self.currThreadIdent, self.mode)
self.logger.info(msg)
try:
requestRecords = {}
for status in reqStatus:
requestRecords.update(self.getRequestRecords(status))
except Exception as err: # general error
msg = "{}: Unknown exception while fetching requests from ReqMgr2. ".format(self.currThreadIdent)
msg += "Error: {}".format(str(err))
self.logger.exception(msg)
try:
total_num_requests = self.msOutputProducer(requestRecords)
msg = "{}: Total {} requests processed from the streamer. ".format(self.currThreadIdent,
total_num_requests)
self.logger.info(msg)
self.updateReportDict(summary, "total_num_requests", total_num_requests)
except Exception as ex:
msg = "{}: Unknown exception while running the Producer thread. ".format(self.currThreadIdent)
msg += "Error: {}".format(str(ex))
self.logger.exception(msg)
self.updateReportDict(summary, "error", msg)
def _executeConsumer(self, summary):
"""
The function to execute the Consumer function itself
:param summary: dictionary with some high level summary for this cycle execution
"""
msg = "{}: MSOutput is running in mode: {} ".format(self.currThreadIdent, self.mode)
self.logger.info(msg)
msg = "{}: Service set to process up to {} requests ".format(self.currThreadIdent,
self.msConfig["limitRequestsPerCycle"])
msg += "per cycle per each type 'RelVal' and 'NonRelval' workflows."
self.logger.info(msg)
if not self.msConfig['enableDataPlacement']:
msg = "{} enableDataPlacement = False. ".format(self.currThreadIdent)
msg += "Running the MSOutput service in dry run mode"
self.logger.warning(msg)
try:
total_num_requests = self.msOutputConsumer()
msg = "{}: Total {} requests processed. ".format(self.currThreadIdent,
total_num_requests)
self.logger.info(msg)
self.updateReportDict(summary, "total_num_requests", total_num_requests)
except Exception as ex:
msg = "{}: Unknown exception while running Consumer thread. ".format(self.currThreadIdent)
msg += "Error: {}".format(str(ex))
self.logger.exception(msg)
self.updateReportDict(summary, "error", msg)
def makeSubscriptions(self, workflow):
"""
The common function to make the final subscriptions
:param workflow: a MSOutputTemplate object workflow
:return: the MSOutputTemplate object itself (with the necessary updates in place)
"""
if not isinstance(workflow, MSOutputTemplate):
msg = "Unsupported type object '{}' for workflows! ".format(type(workflow))
msg += "It needs to be of type: MSOutputTemplate"
raise UnsupportedError(msg)
# NOTE:
# Here is just an example construction of the function. None of the
# data structures used to visualise it is correct. To Be Updated
ruleAttrs = {'activity': 'Production Output',
'lifetime': self.msConfig['rulesLifetime'],
'account': self.msConfig['rucioAccount'],
'grouping': "ALL",
'comment': 'WMCore MSOutput output data placement'}
# add a configurable weight value
ruleAttrs["weight"] = self.msConfig['rucioDiskRuleWeight']
# and RelVals have a different lifetime setting
if workflow['IsRelVal']:
ruleAttrs["lifetime"] = self.msConfig['ruleLifetimeRelVal']
# if anything fail along the way, set it back to "pending"
transferStatus = "done"
for dMap in workflow['OutputMap']:
if dMap['Copies'] == 0:
msg = "Output dataset configured to 0 copies, so skipping it. Details:"
msg += "\n\tWorkflow name: {}".format(workflow['RequestName'])
msg += "\n\tDataset name: {}".format(dMap['Dataset'])
msg += "\n\tCampaign name: {}".format(dMap['Campaign'])
self.logger.warning(msg)
continue
if dMap['DiskRuleID']:
msg = "Output dataset: {} from workflow: {} ".format(dMap['Dataset'], workflow['RequestName'])
msg += " has been already locked by rule id: {}".format(dMap['DiskRuleID'])
self.logger.info(msg)
continue
self.logger.info("Performing rucio rule creation for workflow: %s, dataset: %s",
workflow['RequestName'], dMap['Dataset'])
ruleAttrs.update({'copies': dMap['Copies']})
if self.msConfig['enableDataPlacement']:
resp = self.rucio.createReplicationRule(dMap['Dataset'], dMap['DiskDestination'], **ruleAttrs)
if not resp:
# then the call failed
transferStatus = "pending"
elif len(resp) == 1:
dMap['DiskRuleID'] = resp[0]
elif len(resp) > 1:
msg = "Rule creation returned multiple rule IDs and it needs to be investigated!!! "
msg += "For DID: {}, rseExpr: {} and rucio account: {}".format(dMap['Dataset'],
dMap['DiskDestination'],
ruleAttrs['account'])
self.logger.critical(msg)
return workflow
else:
msg = "DRY-RUN RUCIO: skipping rule creation for DID: {}, ".format(dMap['Dataset'])
msg += "rseExpr: {} and standard parameters: {}".format(dMap['DiskDestination'], ruleAttrs)
self.logger.info(msg)
# Finally, update the MSOutput template document with either partial or
# complete transfer ids
self.docKeyUpdate(workflow, OutputMap=workflow['OutputMap'])
workflow.updateTime()
if transferStatus == "done":
self.logger.info("All the disk requests succeeded for: %s. Marking it as 'done'",
workflow['RequestName'])
self.docKeyUpdate(workflow, TransferStatus='done')
else:
self.logger.info("Disk requests partially successful for: %s. Keeping it 'pending'",
workflow['RequestName'])
# NOTE:
# if we are about to implement this through a pipeline we MUST not
# return the result here but the WHOLE document with updated fields
# for the transfer as it will be passed to the next function in
# the pipeline and uploaded to MongoDB
return workflow
def makeTapeSubscriptions(self, workflow):
"""
Makes the output data placement to the Tape endpoints. It works either with
PhEDEx or with Rucio, configurable. It also relies on the Unified configuration
to decide whether a given datatier can go to tape, and where it can be auto-approved.
:param workflow: a MSOutputTemplate object representing a workflow
:return: the MSOutputTemplate object itself (with the necessary updates in place)
"""
# if anything fails along the way, set it back to "pending"
transferStatus = "done"
# this RSE name will be used for all output datasets to be subscribed
# within this workflow
dataBytesForTape = self._getDataVolumeForTape(workflow)
tapeRSE, requiresApproval = self._getTapeDestination(dataBytesForTape)
self.logger.info("Workflow: %s, total output size: %s GB, against RSE: %s",
workflow['RequestName'], gigaBytes(dataBytesForTape), tapeRSE)
for dMap in workflow['OutputMap']:
if not self.canDatasetGoToTape(dMap, workflow):
continue
# this RSE name will be used for all output datasets to be subscribed
# within this workflow
dMap['TapeDestination'] = tapeRSE
ruleAttrs = {'activity': 'Production Output',
'account': self.msConfig['rucioAccount'],
'copies': 1,
'grouping': "ALL",
'ask_approval': requiresApproval,
'comment': 'WMCore MSOutput output data placement'}
msg = "Creating Rucio TAPE rule for container: {} and RSE: {}".format(dMap['Dataset'],
dMap['TapeDestination'])
self.logger.info(msg)
if self.msConfig['enableDataPlacement']:
resp = self.rucio.createReplicationRule(dMap['Dataset'], dMap['TapeDestination'], **ruleAttrs)
if not resp:
# then the call failed
transferStatus = "pending"
elif len(resp) == 1:
dMap['TapeRuleID'] = resp[0]
elif len(resp) > 1:
msg = "Tape rule creation returned multiple rule IDs and it needs to be investigated!!! "
msg += "For DID: {}, rseExpr: {} and rucio account: {}".format(dMap['Dataset'],
dMap['TapeDestination'],
ruleAttrs['account'])
self.logger.critical(msg)
return workflow
else:
msg = "DRY-RUN RUCIO: skipping tape rule creation for DID: {}, ".format(dMap['Dataset'])
msg += "rseExpr: {} and standard parameters: {}".format(dMap['TapeDestination'], ruleAttrs)
self.logger.info(msg)
# Finally, update the MSOutput template document with either partial or
# complete transfer ids
self.docKeyUpdate(workflow, OutputMap=workflow['OutputMap'])
workflow.updateTime()
# NOTE: updating the TransferStatus at this stage is a bit trickier, we
# cannot bypass bad disk data placements!
if transferStatus == "done" and workflow['TransferStatus'] == "done":
self.logger.info("All the tape requests succeeded for: %s. Marking it as 'done'",
workflow['RequestName'])
elif transferStatus == "done" and workflow['TransferStatus'] == "pending":
self.logger.info("All the tape requests succeeded for: %s, but disk ones are still pending",
workflow['RequestName'])
elif transferStatus == "pending" and workflow['TransferStatus'] == "done":
self.logger.info("Tape requests partially successful for: %s. Marking it as 'pending'",
workflow['RequestName'])
self.docKeyUpdate(workflow, TransferStatus='pending')
else:
self.logger.info("Tape requests partially successful for: %s. Keeping it as 'pending'",
workflow['RequestName'])
return workflow
def _getTapeDestination(self, dataSize):
"""
Depending on which Data Management system this service is configured
to use. Run a different procedure to find out which tape endpoint to
select as a destination for all the output datasets in a given workflow
:param dataSize: integer with the total amount of data to be transferred, in bytes
:return: a string with the RSE name
"""
# This API returns a tuple with the RSE name and whether it requires approval
return self.rucio.pickRSE(rseExpression=self.msConfig["rucioTapeExpression"],
rseAttribute=self.msConfig["rucioRSEAttribute"],
minNeeded=dataSize)
def getRequestRecords(self, reqStatus):
"""
Queries ReqMgr2 for requests in a given status.
NOTE: to be taken from MSTransferor with minor changes
"""
self.logger.info("Fetching requests in status: %s", reqStatus)
result = self.reqmgr2.getRequestByStatus([reqStatus], detail=True)
if not result:
requests = {}
else:
requests = result[0]
self.logger.info(' retrieved %s requests in status: %s', len(requests), reqStatus)
return requests
def msOutputConsumer(self):
"""
A top level function to drive the creation and book keeping of all the
subscriptions to the Data Management System
"""
# DONE:
# Done: To check if the 'enableDataPlacement' flag is really taken into account
# Done: To make this for both relvals and non relvals
# Done: To return the result
# Done: To make report document
# Done: To build it through a pipe
# Done: To write back the updated document to MonogoDB
msPipelineRelVal = Pipeline(name="MSOutputConsumer PipelineRelVal",
funcLine=[Functor(self.makeSubscriptions),
Functor(self.makeTapeSubscriptions),
Functor(self.docUploader,
update=True,
keys=['LastUpdate',
'TransferStatus',
'OutputMap']),
Functor(self.docDump, pipeLine='PipelineRelVal'),
Functor(self.docCleaner)])
msPipelineNonRelVal = Pipeline(name="MSOutputConsumer PipelineNonRelVal",
funcLine=[Functor(self.makeSubscriptions),
Functor(self.makeTapeSubscriptions),
Functor(self.docUploader,
update=True,
keys=['LastUpdate',
'TransferStatus',
'OutputMap']),
Functor(self.docDump, pipeLine='PipelineNonRelVal'),
Functor(self.docCleaner)])
wfCounterTotal = 0
mQueryDict = {'TransferStatus': 'pending'}
pipeCollections = [(msPipelineRelVal, self.msOutRelValColl),
(msPipelineNonRelVal, self.msOutNonRelValColl)]
for pipeColl in pipeCollections:
wfCounters = 0
pipeLine = pipeColl[0]
dbColl = pipeColl[1]
pipeLineName = pipeLine.getPipelineName()
for docOut in self.getDocsFromMongo(mQueryDict, dbColl, self.msConfig['limitRequestsPerCycle']):
# FIXME:
# To redefine those exceptions as MSoutputExceptions and
# start using those here so we do not mix with general errors
try:
# If it's in MongoDB, it can get into our in-memory cache
self.requestNamesCached.append(docOut['RequestName'])
pipeLine.run(docOut)
except (KeyError, TypeError) as ex:
msg = "%s Possibly malformed record in MongoDB. Err: %s. " % (pipeLineName, str(ex))
msg += "Continue to the next document."
self.logger.exception(msg)
continue
except EmptyResultError as ex:
msg = "%s All relevant records in MongoDB exhausted. " % pipeLineName
msg += "We are done for the current cycle."
self.logger.info(msg)
break
except Exception as ex:
msg = "%s General error from pipeline. Err: %s. " % (pipeLineName, str(ex))
msg += "Will retry again in the next cycle."
self.logger.exception(msg)
break
wfCounters += 1
self.logger.info("Processed %d workflows from pipeline: %s", wfCounters, pipeLineName)
wfCounterTotal += wfCounters
return wfCounterTotal
def msOutputProducer(self, requestRecords):
"""
A top level function to fetch requests from ReqMgr2, and produce the correspondent
records for MSOutput in MongoDB.
:param requestRecords: list of request dictionaries retrieved from ReqMgr2
It's implemented as a pipeline, performing the following sequential actions:
1) document transformer - creates a MSOutputTemplate object from the request dict
2) document info updater - parses the MSOutputTemplate object and updates the
necessary data structure mapping output/locations/campaign/etc
3) document uploader - inserts the MSOutputTemplate object into the correct
MongoDB collection (ReVal is separated from standard workflows)
4) document cleaner - releases memory reference to the MSOutputTemplate object
"""
# DONE:
# to set a destructive function at the end of the pipeline
# NOTE:
# To discuss the collection names
# NOTE:
# Here we should never use docUploader with `update=True`, because
# this will erase the latest state of already existing and fully or
# partially processed documents by the Consumer pipeline
self.logger.info("Running the msOutputProducer ...")
msPipeline = Pipeline(name="MSOutputProducer Pipeline",
funcLine=[Functor(self.docTransformer),
Functor(self.docInfoUpdate),
Functor(self.docUploader),
Functor(self.docCleaner)])
# TODO:
# To generate the object from within the Function scope see above.
counter = 0
for _, request in requestRecords.viewitems():
if request['RequestName'] in self.requestNamesCached:
# if it's cached, then it's already in MongoDB, no need to redo this thing!
continue
counter += 1
try:
pipeLineName = msPipeline.getPipelineName()
msPipeline.run(request)
except (KeyError, TypeError) as ex:
msg = "%s Possibly broken read from ReqMgr2 API or other. Err: %s." % (pipeLineName, str(ex))
msg += " Continue to the next document."
self.logger.exception(msg)
continue
except Exception as ex:
msg = "%s General Error from pipeline. Err: %s. " % (pipeLineName, str(ex))
msg += "Giving up Now."
self.logger.exception(str(ex))
break
return counter
def docTransformer(self, doc):
"""
A function used to transform a request record from reqmgr2 to a document
suitable for uploading to Mongodb
"""
# Solution 1: Destructive function - to force clear of the the externally
# referenced object and to return a new one (current solution)
# NOTE: Leaves an empty dictionary behind (the clear method just
# clears all the keys of the dict, but does not delete it)
# Solution 2: To work in place (will keep the dynamic structure of the passed dict)
# Solution 3: To have 2 object buffers for the two diff types outside the function
try:
msOutDoc = MSOutputTemplate(doc)
except Exception as ex:
msg = "ERR: Unable to create MSOutputTemplate for document: \n%s\n" % pformat(doc)
msg += "ERR: %s" % str(ex)
self.logger.exception(msg)
raise ex
return msOutDoc
def docDump(self, msOutDoc, pipeLine=None):
"""
Prints document contents
"""
msg = "{}: {}: Processed 'msOutDoc' with '_id': {}.".format(self.currThreadIdent,
pipeLine,
msOutDoc['_id'])
self.logger.info(msg)
self.logger.debug(pformat(msOutDoc))
return msOutDoc
def docKeyUpdate(self, msOutDoc, **kwargs):
"""
A function used to update one or few particular fields in a document
:**kwargs: The keys/value pairs to be updated (will be tested against MSOutputTemplate)
"""
for key, value in kwargs.items():
try:
msOutDoc.setKey(key, value)
msOutDoc.updateTime()
except Exception as ex:
msg = "Cannot update key {} for doc: {}\n".format(key, msOutDoc['_id'])
msg += "Error: {}".format(str(ex))
self.logger.warning(msg)
return msOutDoc
def docInfoUpdate(self, msOutDoc):
"""
Parses the request parameters (a mongoDB record, not yet persisted) and finds
out what are the disk destinations and how many copies of each dataset need to
be made.
:param msOutDoc: a MSOutput template object
:return: nothing, the MSOutput template record is update in memory.
"""
self.logger.info("Producing MongoDB record for workflow: %s", msOutDoc["RequestName"])
updatedOutputMap = []
for dataItem in msOutDoc['OutputMap']:
if msOutDoc['RequestType'] == "Resubmission":
# make sure not to subscribe the same datasets multiple times, even
# worse, to different locations! Initial workflow will take care of everything!
dataItem['Copies'] = 0
updatedOutputMap.append(dataItem)
continue
### Fetch the dataset size, even if it does not go to Disk (it might go to Tape)
bytesSize = self._getDatasetSize(dataItem['Dataset'])
dataItem['DatasetSize'] = bytesSize
if not self.canDatasetGoToDisk(dataItem, msOutDoc['IsRelVal']):
# nope, this dataset cannot proceed to Disk!!
dataItem['Copies'] = 0
updatedOutputMap.append(dataItem)
continue
try:
dataItem['Copies'] = self.campaigns[dataItem['Campaign']]["MaxCopies"]
except KeyError:
# it can happen for RelVals, but canDatasetGoToDisk method above
# will already take the necessary action for non existent campaign
dataItem['Copies'] = 1
if msOutDoc['IsRelVal']:
_, dsn, procString, dataTier = dataItem['Dataset'].split('/')
destination = set()
if dataTier != "RECO" and dataTier != "ALCARECO":
destination.add('T2_CH_CERN')
if dataTier == "GEN-SIM":
destination.add('T1_US_FNAL_Disk')
if dataTier == "GEN-SIM-DIGI-RAW":
destination.add('T1_US_FNAL_Disk')
if dataTier == "GEN-SIM-RECO":
destination.add('T1_US_FNAL_Disk')
if "RelValTTBar" in dsn and "TkAlMinBias" in procString and dataTier != "ALCARECO":
destination.add('T2_CH_CERN')
if "MinimumBias" in dsn and "SiStripCalMinBias" in procString and dataTier != "ALCARECO":
destination.add('T2_CH_CERN')
if destination:
dataItem['DiskDestination'] = '|'.join(destination)
else:
self.logger.warning("RelVal dataset: %s without any destination", dataItem['Dataset'])
dataItem['Copies'] = 0
updatedOutputMap.append(dataItem)
continue
else:
# FIXME:
# Here we need to use the already created campaignMap for
# building the destinationOutputMap for nonRelVal workflows.
# For the time being it is a fallback to all T1_* and all T2_*.
# Once we migrate to Rucio we should change those defaults to
# whatever is the format in Rucio (eg. referring a subscription
# rule like: "store it at a good site" or "Store in the USA" etc.)
# NOTE: This default rseExpression should target all T1_*_Disk and T2_*
# sites, where the first part is a Union of those Tiers and the second
# part is a general constraint for those to be real entries (not `Test`
# or `Temp`) and we also target only Disk endpoints
dataItem['DiskDestination'] = '(tier=2|tier=1)&cms_type=real&rse_type=DISK'
updatedOutputMap.append(dataItem)
try:
msOutDoc.updateDoc({"OutputMap": updatedOutputMap}, throw=True)
except Exception as ex:
msg = "%s: Could not update the additional information for "
msg += "'msOutDoc' with '_id': %s \n"
msg += "Error: %s"
self.logger.exception(msg, self.currThreadIdent, msOutDoc['_id'], str(ex))
return msOutDoc
def _getDatasetSize(self, datasetName):
"""
Retrieve the dataset size from the correct DM system
This size is needed for the tape data placement
:param datasetName: string with the dataset name
:return: an integer with the total dataset size, in bytes
"""
didInfo = self.rucio.getDID(datasetName)
# let the exception be raised if we failed to calculate the dataset size
return didInfo["bytes"]
def canDatasetGoToDisk(self, dataItem, isRelVal=False):
"""
This function evaluates whether a dataset can be passed to the
Data Management system, considering the following configurations:
1) list of blacklisted tiers in the MicroService configuration
2) list of white listed tiers bypassing the Unified configuration
3) list of black and white listed tiers in the Unified config
:param dataItem: dictionary information for this dataset, from MongoDB record
:param isRelVal: boolean flag identifying if dataset belongs to a RelVal request
:return: True if the dataset is allowed to pass, False otherwise
"""
dataTier = dataItem['Dataset'].split('/')[-1]
if dataTier in self.msConfig['excludeDataTier']:
self.logger.warning("Skipping dataset: %s because it's excluded in the MS configuration",
dataItem['Dataset'])
return False
try:
if dataTier in self.campaigns[dataItem['Campaign']]["TiersToDM"]:
return True
except KeyError:
if isRelVal:
msg = "Campaign not found for RelVal dataset: {} ".format(dataItem['Dataset'])
msg += "under campaign: {}. Letting it pass though...".format(dataItem['Campaign'])
self.logger.warning(msg)
return True
emailSubject = "[MSOutput] Campaign '{}' not found in central CouchDB".format(dataItem['Campaign'])
emailMsg = "Dataset: {} cannot have an output transfer rule ".format(dataItem['Dataset'])
emailMsg += "because its campaign: {} cannot be found in central CouchDB.".format(dataItem['Campaign'])
emailMsg += " In order to get output data placement working, add it ASAP please."
self.logger.critical(emailMsg)
if self.msConfig["sendNotification"]:
self.emailAlert.send(emailSubject, emailMsg)
raise
if dataTier in self.uConfig['tiers_to_DDM']['value']:
return True
elif dataTier in self.uConfig['tiers_no_DDM']['value']:
return False
else:
emailSubject = "[MSOutput] Datatier not found in the Unified configuration: {}".format(dataTier)
emailMsg = "Dataset: {} contains a datatier: {}".format(dataItem['Dataset'], dataTier)
emailMsg += " not yet inserted into Unified configuration. "
emailMsg += "Please add it ASAP. Letting it pass for now..."
self.logger.critical(emailMsg)
if self.msConfig["sendNotification"] and not isRelVal:
self.emailAlert.send(emailSubject, emailMsg)
return True
def _getDataVolumeForTape(self, workflow):
"""
This function does a similar logic as `canDatasetGoToTape` and
calculates the total size of all the output datasets that need
to be pinned on tape
:param workflow: MSOutputTemplate object retrieved from MongoDB
:return: integer with the total size in bytes
"""
totalSize = 0
for dataItem in workflow['OutputMap']:
if workflow['IsRelVal'] and not self.msConfig['enableRelValCustodial']:
return False
if dataItem['TapeRuleID']:
continue
dataTier = dataItem['Dataset'].split('/')[-1]
if dataTier in self.msConfig['excludeDataTier']:
continue
elif dataTier in self.uConfig['tiers_with_no_custodial']['value']:
continue
# otherwise, we are about to transfer it
totalSize += dataItem['DatasetSize']
return totalSize
def canDatasetGoToTape(self, dataItem, workflow):
"""
This function evaluates whether a dataset can be passed to the
Data Management system, considering the following configurations:
1) list of blacklisted tiers in the MicroService configuration
2) list of white listed tiers bypassing the Unified configuration
3) list of black and white listed tiers in the Unified config
:param dataItem: output map dictionary present in the MongoDB record
:param workflow: MSOutputTemplate object retrieved from MongoDB
:return: True if the dataset is allowed to pass, False otherwise
NOTE: changes here should usually be applied to `_getDataVolumeForTape` too
"""
# NOTE: Unified has a `tape_size_limit` parameter, to prevent automatic
# tape subscription for too large samples. We are not going to implement
# it - for the moment - at least.
if workflow['IsRelVal'] and not self.msConfig['enableRelValCustodial']:
return False
if workflow['RequestType'] == "Resubmission":
# their parent/original workflow will take care of all the data placement
return False
if dataItem['TapeRuleID']:
msg = "Output dataset: {} from workflow: {} ".format(dataItem['Dataset'], workflow['RequestName'])
msg += " has been already subscribed to TAPE under request id: {}".format(dataItem['TapeRuleID'])
self.logger.info(msg)
return False
dataTier = dataItem['Dataset'].split('/')[-1]
if dataTier in self.msConfig['excludeDataTier']:
msg = "Skipping tape data placement for dataset: {} ".format(dataItem['Dataset'])
msg += "because it's been excluded in the MS configuration."
self.logger.warning(msg)
return False
if dataTier in self.uConfig['tiers_with_no_custodial']['value']:
msg = "Skipping tape data placement for dataset: {} ".format(dataItem['Dataset'])
msg += "because Unified configuration sets it not to go to tape."
self.logger.warning(msg)
return False
# if we are here, that means the dataset can proceed to tape
return True
def docUploader(self, msOutDoc, update=False, keys=None, stride=None):
"""
A function to upload documents to MongoDB. The session object to the relevant
database and Collection must be passed as arguments
:msOutDocs: A list of documents of type MSOutputTemplate
:stride: the max number of documents we are about to upload at once
:update: A flag to trigger document update in MongoDB in case of duplicates
:keys: A list of keys to update. If missing the whole document will be updated
"""
# NOTE: We must return the document(s) at the end so that it can be explicitly
# deleted outside the pipeline
# figure out which database collection to use, based on RelVal or standard workflow
if msOutDoc["IsRelVal"]:
dbColl = self.msOutRelValColl
else:
dbColl = self.msOutNonRelValColl
# Skipping documents avoiding index unique property (documents having the
# same value for the indexed key as an already uploaded document)
try:
dbColl.insert_one(msOutDoc)
except errors.DuplicateKeyError:
# DONE:
# Here we may wish to double check and make document update, so
# that a change of the Request on ReqMgr may be reflected here too
# NOTE:
# If we use the 'update' option with a fresh document created from
# Reqmgr and we overwrite an already existing document in MongoDB
# which have been already worked on - we will loose the information
# that have been stored in the MonggDB - so always use 'update'
# with the proper set of keys to be updated
if not keys:
keys = []
# update only the requested keys:
if update and keys:
updateDict = {}
for key in keys:
updateDict[key] = msOutDoc[key]
msOutDoc = dbColl.find_one_and_update(
{'_id': msOutDoc['_id']},
{'$set': updateDict},
return_document=ReturnDocument.AFTER)
if update and not keys:
msOutDoc = dbColl.find_one_and_update(
{'_id': msOutDoc['_id']},
{'$set': msOutDoc},
return_document=ReturnDocument.AFTER)
return msOutDoc
def getDocsFromMongo(self, mQueryDict, dbColl, limit=1000):
"""
Reads documents from MongoDB and convert them to an MSOutputTemplate
object. Limit can be provided to control the amount of records to be
returned:
:param mQueryDict: dictionary with the Mongo query to be executed
:param dbColl: connection object to the database/collection
:param limit: integer with the amount of documents meant to be returned
:return: it yields an MSOutputTemplate object
"""
# NOTE:
# In case the current query returns an empty document from MongoDB
# (eg. all workflows have been processed) the MSOutputTemplate
# will throw an error. We should catch this one here and interrupt
# the pipeLine traversal, otherwise an error either here or in one of the
# following stages will most probably occur and the whole run will be broken.
counter = 0
for mongoDoc in dbColl.find(mQueryDict):
if counter >= limit:
return
try:
msOutDoc = MSOutputTemplate(mongoDoc, producerDoc=False)
counter += 1
yield msOutDoc
except Exception as ex:
msg = "Failed to create MSOutputTemplate object from mongo record: {}.".format(mongoDoc)
msg += " Error message was: {}".format(str(ex))
self.logger.exception(msg)
raise ex
else:
self.logger.info("%s Query: '%s' did not return any records from MongoDB", dbColl.name, mQueryDict)
def getTransferInfo(self, reqName):
"""
Searches and reads a document from MongoDB in all collections related to
the MSOutput service. It is supposed to be called only by MSManager e.g.:
transferDoc = self.msOutputProducer.getTransferInfo(reqName)
And the output to be served to the REST interface, so that all request
transfer records can be tracked.
:param reqName: The name of the request to be searched for
:return: a list of all msOutDocs with the record if it exists or None otherwise
"""
mQueryDict = {'RequestName': reqName}
result = []
stripKeys = ['_id']
for dbColl in [self.msOutNonRelValColl, self.msOutRelValColl]:
doc = dbColl.find_one(mQueryDict)
if doc:
for key in stripKeys:
doc.pop(key, None)
result.append(doc)
break
return result
def docCleaner(self, doc):
"""
Calls the dictionary internal method clear() and purges all the contents
of the document
"""
return doc.clear()