python.TrigValSteering.CheckSteps.MessageCountStep Class Reference

Inheritance diagram for python.TrigValSteering.CheckSteps.MessageCountStep:

Collaboration diagram for python.TrigValSteering.CheckSteps.MessageCountStep:

Public Member Functions
	__init__ (self, name='MessageCount')
	configure (self, test)
	run (self, dry_run=False)

Public Attributes
str	executable = 'messageCounter.py'
str	log_regex = r'(athena\.(?!.*tail).*log$|athenaHLT:.*\.out$|^log\.(.*to.*|Derivation))'
list	skip_logs = []
str	start_pattern = r'(HltEventLoopMgr|AthenaHiveEventLoopMgr).*INFO Starting loop on events'
str	end_pattern = r'(HltEventLoopMgr.*INFO All events processed|AthenaHiveEventLoopMgr.*INFO.*Loop Finished)'
	print_on_fail = None
dict	thresholds = {}
bool	auto_report_result = True
bool	depends_on_exec = True
	name
int	result = 1

Detailed Description

Count messages printed inside event loop

Definition at line 621 of file CheckSteps.py.

Constructor & Destructor Documentation

__init__()

python.TrigValSteering.CheckSteps.MessageCountStep.__init__	(		self,
			name = 'MessageCount' )

Definition at line 624 of file CheckSteps.py.

    def __init__(self, name='MessageCount'):
        super(MessageCountStep, self).__init__(name)
        self.executable = 'messageCounter.py'
        self.log_regex = r'(athena\.(?!.*tail).*log$|athenaHLT:.*\.out$|^log\.(.*to.*|Derivation))'
        self.skip_logs = []
        self.start_pattern = r'(HltEventLoopMgr|AthenaHiveEventLoopMgr).*INFO Starting loop on events'
        self.end_pattern = r'(HltEventLoopMgr.*INFO All events processed|AthenaHiveEventLoopMgr.*INFO.*Loop Finished)'
        self.print_on_fail = None
        self.thresholds = {}
        self.auto_report_result = True
        self.depends_on_exec = True  # skip if ExecSteps failed
 

Member Function Documentation

configure()

python.TrigValSteering.CheckSteps.MessageCountStep.configure	(		self,
			test )

Definition at line 636 of file CheckSteps.py.

    def configure(self, test):
        self.args += ' -s "{:s}"'.format(self.start_pattern)
        self.args += ' -e "{:s}"'.format(self.end_pattern)
        if self.print_on_fail is None:
            self.print_on_fail = self.required
        if self.print_on_fail:
            self.args += ' --saveAll'
 
        max_events = test.exec_steps[0].max_events if isinstance(test.exec_steps[0], ExecStep) else 0
        if 'WARNING' not in self.thresholds:
            self.thresholds['WARNING'] = 0
        if 'INFO' not in self.thresholds:
            self.thresholds['INFO'] = max_events
        if 'DEBUG' not in self.thresholds:
            self.thresholds['DEBUG'] = 0
        if 'VERBOSE' not in self.thresholds:
            self.thresholds['VERBOSE'] = 0
        if 'other' not in self.thresholds:
            self.thresholds['other'] = max_events
        super(MessageCountStep, self).configure(test)
 

run()

python.TrigValSteering.CheckSteps.MessageCountStep.run	(		self,
			dry_run = False )

Definition at line 657 of file CheckSteps.py.

    def run(self, dry_run=False):
        files = os.listdir('.')
        r = re.compile(self.log_regex)
        log_files = [f for f in filter(r.match, files) if f not in self.skip_logs]
        if not log_files and not dry_run:
            self.log.error('%s found no log files matching the pattern %s', self.name, self.log_regex)
            self.result = 1
            if self.auto_report_result:
                self.report_result()
            return self.result, '# (internal) {} -> failed'.format(self.name)
        self.args += ' ' + ' '.join(log_files)
        auto_report = self.auto_report_result
        self.auto_report_result = False
        ret, cmd = super(MessageCountStep, self).run(dry_run)
        self.auto_report_result = auto_report
        if ret != 0:
            self.log.error('%s failed', self.name)
            self.result = 1
            if self.auto_report_result:
                self.report_result()
            return self.result, cmd
 
        for log_file in log_files:
            json_file = 'MessageCount.{:s}.json'.format(log_file)
            if self.print_on_fail:
                all_json_file = 'Messages.{:s}.json'.format(log_file)
            if not os.path.isfile(json_file):
                self.log.warning('%s cannot open file %s', self.name, json_file)
            with open(json_file) as f:
                summary = json.load(f)
                for level, threshold in self.thresholds.items():
                    if summary[level] > threshold:
                        self.result += 1
                        self.log.info(
                            '%s Number of %s messages %s in %s is higher than threshold %s',
                            self.name, level, summary[level], log_file, threshold)
                        if self.print_on_fail:
                            self.log.info('%s Printing all %s messages from %s', self.name, level, log_file)
                            with open(all_json_file) as af:
                                all_msg = json.load(af)
                                for msg in all_msg[level]:
                                    print(msg.strip())  # noqa: ATL901
 
        if self.auto_report_result:
            self.report_result()
        return self.result, cmd
 
 

Member Data Documentation

auto_report_result

bool python.TrigValSteering.CheckSteps.MessageCountStep.auto_report_result = True

Definition at line 633 of file CheckSteps.py.

depends_on_exec

bool python.TrigValSteering.CheckSteps.MessageCountStep.depends_on_exec = True

Definition at line 634 of file CheckSteps.py.

end_pattern

str python.TrigValSteering.CheckSteps.MessageCountStep.end_pattern = r'(HltEventLoopMgr.*INFO All events processed|AthenaHiveEventLoopMgr.*INFO.*Loop Finished)'

Definition at line 630 of file CheckSteps.py.

executable

str python.TrigValSteering.CheckSteps.MessageCountStep.executable = 'messageCounter.py'

Definition at line 626 of file CheckSteps.py.

log_regex

python.TrigValSteering.CheckSteps.MessageCountStep.log_regex = r'(athena\.(?!.*tail).*log$|athenaHLT:.*\.out$|^log\.(.*to.*|Derivation))'

Definition at line 627 of file CheckSteps.py.

name

python.TrigValSteering.CheckSteps.MessageCountStep.name

Definition at line 662 of file CheckSteps.py.

print_on_fail

python.TrigValSteering.CheckSteps.MessageCountStep.print_on_fail = None

Definition at line 631 of file CheckSteps.py.

result

python.TrigValSteering.CheckSteps.MessageCountStep.result = 1

Definition at line 663 of file CheckSteps.py.

skip_logs

list python.TrigValSteering.CheckSteps.MessageCountStep.skip_logs = []

Definition at line 628 of file CheckSteps.py.

start_pattern

str python.TrigValSteering.CheckSteps.MessageCountStep.start_pattern = r'(HltEventLoopMgr|AthenaHiveEventLoopMgr).*INFO Starting loop on events'

Definition at line 629 of file CheckSteps.py.

thresholds

dict python.TrigValSteering.CheckSteps.MessageCountStep.thresholds = {}

Definition at line 632 of file CheckSteps.py.

---

The documentation for this class was generated from the following file:

• CheckSteps.py