Warn about bit number above trigger collections sizes only once per event/bx

[perrotta]

PR description:

Logs in a few test outputs are now flooded by warning messages from L1TGlobalProducer. This makes difficult to find other warnings and debug possible other issues in the code.

For example, in wf 136.731 the MessageLogger Summary says:

MessageLogger Summary

 type     category        sev    module        subroutine        count    total
 ---- -------------------- -- ---------------- ----------------  -----    -----
    1 Configuration        -w HLTHighLevel:ALC                       2        2
    2 L1TGlobal            -w L1TGlobalProduce                   10868    10868
    3 HLTConfigProvider    -e DQMPFCandidateAn                       2        2
    4 HLTConfigProvider    -e METAnalyzer:pfMe                       2        2
    5 HLTConfigProvider    -e METAnalyzer:pfPu                       2        2
    6 TimeReport           -e AfterModEndJob                         1*       1
    7 hltPrescaleTable     -e PATTriggerProduc                       1        1
    8 fileAction           -s file_close                             1        1
    9 fileAction           -s file_open                              2        2

* Some occurrences of this message were suppressed in all logs, due to limits.

 type    category    Examples: run/evt        run/evt          run/evt
 ---- -------------------- ---------------- ---------------- ----------------
    1 Configuration        274199/39389360  274199/38626099  
    2 L1TGlobal            274199/39389360  274199/39389360  274199/39733340
    3 HLTConfigProvider    Run: 274199      Run: 274199      
    4 HLTConfigProvider    Run: 274199      Run: 274199      
    5 HLTConfigProvider    Run: 274199      Run: 274199      
    6 TimeReport           EndJob                            
    7 hltPrescaleTable     274199/39389360                   
    8 fileAction           PostGlobalEndRun                  
    9 fileAction           pre-events       pre-events       

Severity    # Occurrences   Total Occurrences
--------    -------------   -----------------
Warning             10870               10870
Error                   8                   8
System                  3                   3

Those warnings are repeated for every BX in the event and for every bit number above the vector dimension thresholds. Since there is no information on the bit number itself, having that message repeated multiple time is completely useless.

One possibility to reduce the number of those logWarnings is to have them only printed once per event (this is needed, because different events my have different trigger menus) and per bx, and not for every single bit in a given bx. This is what is implemented in this PR. (Actually, I don't think that repeating the same warning at every bx can have any usefulness, but I did not want to hit thread safety issues in doing it).

With this PR, the MessageLogger Summary for the same wf 136.731 becomes:

MessageLogger Summary

 type     category        sev    module        subroutine        count    total
 ---- -------------------- -- ---------------- ----------------  -----    -----
    1 Configuration        -w HLTHighLevel:ALC                       2        2
    2 L1TGlobal            -w L1TGlobalProduce                    1000     1000
    3 HLTConfigProvider    -e DQMPFCandidateAn                       2        2
    4 HLTConfigProvider    -e METAnalyzer:pfMe                       2        2
    5 HLTConfigProvider    -e METAnalyzer:pfPu                       2        2
    6 hltPrescaleTable     -e PATTriggerProduc                       1        1
    7 fileAction           -s file_close                             1        1
    8 fileAction           -s file_open                              2        2

 type    category    Examples: run/evt        run/evt          run/evt
 ---- -------------------- ---------------- ---------------- ----------------
    1 Configuration        274199/39389360  274199/38626099  
    2 L1TGlobal            274199/39389360  274199/39389360  274199/39733340
    3 HLTConfigProvider    Run: 274199      Run: 274199      
    4 HLTConfigProvider    Run: 274199      Run: 274199      
    5 HLTConfigProvider    Run: 274199      Run: 274199      
    6 hltPrescaleTable     274199/39389360                   
    7 fileAction           PostGlobalEndRun                  
    8 fileAction           pre-events       pre-events       

Severity    # Occurrences   Total Occurrences
--------    -------------   -----------------
Warning              1002                1002
Error                   7                   7
System                  3                   3

The outputs are not yet fully cleaned, but with a factor 10 reduction of the repeatedly identical messages the logs already become much better readable and inspectable for other messages.

To the attention of @cms-sw/l1-l2

PR validation:

It compiles and actually cleans up (a bit) the logs, without removing information from the warning message

[cmsbuild]

The code-checks are being triggered in jenkins.

[cmsbuild]

-code-checks

Logs: https://cmssdt.cern.ch/SDT/code-checks/cms-sw-PR-31256/17923

• This PR adds an extra 20KB to repository

Code check has found code style and quality issues which could be resolved by applying following patch(s)

• code-format:
  https://cmssdt.cern.ch/SDT/code-checks/cms-sw-PR-31256/17923/code-format.patch
  e.g. curl https://cmssdt.cern.ch/SDT/code-checks/cms-sw-PR-31256/17923/code-format.patch | patch -p1
  You can also run scram build code-format to apply code format directly

[cmsbuild]

The code-checks are being triggered in jenkins.

[cmsbuild]

+code-checks

Logs: https://cmssdt.cern.ch/SDT/code-checks/cms-sw-PR-31256/17924

• This PR adds an extra 20KB to repository

[perrotta]

please test

[cmsbuild]

The tests are being triggered in jenkins.

• CMSSW_11_2_X_2020-08-26-2300/slc7_amd64_gcc820: https://cmssdt.cern.ch/jenkins/job/ib-run-pr-tests/8947/console Started: 2020/08/27 12:11

[cmsbuild]

A new Pull Request was created by @perrotta for master.

It involves the following packages:

L1Trigger/L1TGlobal

@cmsbuild, @rekovic, @benkrikler can you please review it and eventually sign? Thanks.
@Martin-Grunewald this is something you requested to watch as well.
@silviodonato, @dpiparo, @qliphy you are the release manager for this.

cms-bot commands are listed here

[cmsbuild]

+1
Tested at: 0445ac2
https://cmssdt.cern.ch/SDT/jenkins-artifacts/pull-request-integration/PR-0d4de5/8947/summary.html
CMSSW: CMSSW_11_2_X_2020-08-26-2300
SCRAM_ARCH: slc7_amd64_gcc820

[cmsbuild]

Comparison job queued.

[cmsbuild]

Comparison is ready
https://cmssdt.cern.ch/SDT/jenkins-artifacts/pull-request-integration/PR-0d4de5/8947/summary.html

Comparison Summary:

• No significant changes to the logs found
• Reco comparison results: 3 differences found in the comparisons
• DQMHistoTests: Total files compared: 35
• DQMHistoTests: Total histograms compared: 2609667
• DQMHistoTests: Total failures: 6
• DQMHistoTests: Total nulls: 1
• DQMHistoTests: Total successes: 2609638
• DQMHistoTests: Total skipped: 22
• DQMHistoTests: Total Missing objects: 0
• DQMHistoSizes: Histogram memory added: 0.004 KiB( 34 files compared)
• DQMHistoSizes: changed ( 10224.0 ): 0.004 KiB MessageLogger/Warnings
• Checked 149 log files, 22 edm output root files, 35 DQM output files

[silviodonato]

Any objections @cms-sw/l1-l2 ?

[rekovic]

+1

[cmsbuild]

This pull request is fully signed and it will be integrated in one of the next master IBs (tests are also fine). This pull request will now be reviewed by the release team before it's merged. @silviodonato, @dpiparo, @qliphy (and backports should be raised in the release meeting by the corresponding L2)

[silviodonato]

+1