TrigSteerMonitorConfig.py

Go to the documentation of this file.

# Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
 
from AthenaConfiguration.ComponentAccumulator import ComponentAccumulator
from AthenaConfiguration.ComponentFactory import CompFactory
from AthenaMonitoringKernel.GenericMonitoringTool import GenericMonitoringTool
 
def SchedulerMonSvcCfg(flags, name='SchedulerMonSvc'):
    monsvc = CompFactory.SchedulerMonSvc(name)
    monsvc.MonTool = GenericMonitoringTool(flags, 'MonTool', HistPath='HLTFramework/'+name)
 
    # Helper functions
    def getFlag(flagName, defaultValue):
        if flags.hasCategory('SchedulerMonSvc') and flags.SchedulerMonSvc.hasFlag(flagName):
            return eval('flags.SchedulerMonSvc.'+flagName)
        else:
            return defaultValue
 
    def defineHist1D(varName, varLabel, labels=None, **kwargs):
        monsvc.MonTool.defineHistogram(varName, path='EXPERT', type='TH1D',
                                title=varLabel+';'+varLabel+';Snapshots',
                                xlabels=labels, opt='kCanRebin', **kwargs)
 
    def defineHistVsWallTime(varName, varLabel, _type, labels=None, **kwargs):
        monsvc.MonTool.defineHistogram(
            'WallTimeSeconds,'+varName, path='EXPERT', type=_type,
            title=varLabel+' vs time;Time [s];'+varLabel,
            xbins=600, xmin=0, xmax=60, ylabels=labels, opt='kCanRebin', **kwargs)
 
    def defineHistVsSnapNumber(varName, varLabel, _type, labels=None, **kwargs):
        monsvc.MonTool.defineHistogram(
            'SnapNumber,'+varName, path='EXPERT', type=_type,
            title=varLabel+' vs time (snap number);Snap number;'+varLabel,
            xbins=1000, xmin=0, xmax=1000, ylabels=labels, opt='kCanRebin', **kwargs)
 
    def defineStandardHistogramSet(varName, varLabel, nbins, min, max, labels=None, type2D='TProfile', **kwargs):
        defineHist1D(varName, varLabel, labels, xbins=nbins, xmin=min, xmax=max, **kwargs)
        defineHistVsWallTime(varName, varLabel, type2D, labels, ybins=nbins, ymin=min, ymax=max, **kwargs)
        if enablePlotsVsSnapNumber:
            defineHistVsSnapNumber(varName, varLabel, type2D, labels, ybins=nbins, ymin=min, ymax=max, **kwargs)
 
    # Flags propagated to SchedulerMonSvc properties, can be set with flags.SchedulerMonSvc.<flagName>
    monsvc.SchedulerName = getFlag('SchedulerName', 'AvalancheSchedulerSvc')
    monsvc.MonIntervalMillisec = getFlag('MonIntervalMillisec', 100)
 
    # Flags enabling/disabling histogram categories, can be set with flags.SchedulerMonSvc.<flagName>
    enablePlotsVsSnapNumber = getFlag('enablePlotsVsSnapNumber', False)
    enablePlotsOverThreads = getFlag('enablePlotsOverThreads', True)
    enablePlotsOverSlots = getFlag('enablePlotsOverSlots', True)
    enablePlotsOverActive = getFlag('enablePlotsOverActive', True)
 
    # From GaudiHive AlgsExecutionStates::State enum
    stateNames = ['INITIAL', 'CONTROLREADY', 'DATAREADY', 'RESOURCELESS',
                  'SCHEDULED', 'EVTACCEPTED', 'EVTREJECTED', 'ERROR']
    activeStates = ['CONTROLREADY', 'DATAREADY', 'RESOURCELESS', 'SCHEDULED']
 
    # Histogram definitions
    defineStandardHistogramSet('AlgStates', 'Algorithm state', 8, -0.5, 7.5, labels=stateNames, type2D='TH2D', weight='StateTotalCounts')
    defineStandardHistogramSet('FreeSlots', 'Number of free slots', 10, 0, 10)
    defineStandardHistogramSet('FreeSlotsFraction', 'Fraction of free slots', 100, 0, 1)
    for state in stateNames:
        defineStandardHistogramSet(state, 'N algs in '+state+' state', 100, 0, 100)
    for state in activeStates:
        if enablePlotsOverThreads:
            defineStandardHistogramSet(state+'_Over_Threads', 'N '+state+' / N threads', 100, 0, 10)
        if enablePlotsOverSlots:
            defineStandardHistogramSet(state+'_Over_Slots', 'N '+state+' / N slots', 100, 0, 10)
        if enablePlotsOverActive:
            defineStandardHistogramSet(state+'_Over_Active', 'N '+state+' / N active states', 100, 0, 1)
 
    monsvc.MonTool.defineHistogram('TIME_monCallback', path='EXPERT', type='TH1D',
                                    title='Time of callback calls;Time [us];Calls',
                                    xbins=500, xmin=0, xmax=5000)
 
    acc = ComponentAccumulator()
    acc.addService(monsvc)
    return acc
 
def getTrigErrorMonTool(flags, name='TrigErrorMonTool'):
    errorMonTool = CompFactory.TrigErrorMonTool(name)
    errorMonTool.MonTool = GenericMonitoringTool(flags, 'MonTool', HistPath='HLTFramework/'+name)
 
    errorMonTool.MonTool.defineHistogram(
        'ErrorAlgName,ErrorCode', path='EXPERT', type='TH2I',
        title='Error StatusCodes per algorithm;Algorithm name;StatusCode',
        xbins=1, xmin=0, xmax=1, ybins=1, ymin=0, ymax=1)
 
    return errorMonTool