DUNE-DAQ / DUNE-DAQ/logging

Common trace levels?

Open
#16 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
0
Forks
0
Avg merge
30m
Merged PRs (30d)
1

Description

Some DUNE-DAQ packages define descriptive constants for certain trace levels. Eg

https://github.com/DUNE-DAQ/readout/blob/develop/include/readout/ReadoutLogging.hpp

Some of these descriptive constants are duplicated in multiple packages. It might be worth putting these common constants in a single place.

Here's a list of constant/filename I made from the packages that are part of the 2.6 release. The repeated constants would be the candidates for inclusion in a common list:

 TLVL_BASIC: dfmodules/plugins/HDF5DataStore.hpp   
 TLVL_BOOKKEEPING: dfmodules/plugins/TriggerRecordBuilder.cpp
 TLVL_BOOKKEEPING: flxlibs/plugins/FelixCardReader.cpp
 TLVL_BOOKKEEPING: flxlibs/src/CardWrapper.cpp
 TLVL_BOOKKEEPING: readout/include/readout/ReadoutLogging.hpp
 TLVL_CANDIDATE: trigger/include/trigger/Issues.hpp
 TLVL_CONFIG: dfmodules/plugins/DataWriter.cpp
 TLVL_DEBUG: logging/include/logging/detail/Logger.hxx                                                                   
 TLVL_DEBUG: logging/include/logging/detail/Logger.hxx
 TLVL_ENTER_EXIT_METHODS: dfmodules/plugins/DataWriter.cpp
 TLVL_ENTER_EXIT_METHODS: dfmodules/plugins/TriggerRecordBuilder.cpp
 TLVL_ENTER_EXIT_METHODS: dfmodules/src/TriggerDecisionForwarder.cpp
 TLVL_ENTER_EXIT_METHODS: dfmodules/src/TriggerInhibitAgent.cpp
 TLVL_ENTER_EXIT_METHODS: flxlibs/plugins/FelixCardReader.cpp
 TLVL_ENTER_EXIT_METHODS: flxlibs/src/CardWrapper.cpp
 TLVL_ENTER_EXIT_METHODS: listrev/plugins/ListReverser.cpp
 TLVL_ENTER_EXIT_METHODS: listrev/plugins/RandomDataListGenerator.cpp
 TLVL_ENTER_EXIT_METHODS: listrev/plugins/ReversedListValidator.cpp
 TLVL_ENTER_EXIT_METHODS: readout/include/readout/ReadoutLogging.hpp
 TLVL_ENTER_EXIT_METHODS: timinglibs/include/timinglibs/TimingIssues.hpp
 TLVL_ENTER_EXIT_METHODS: trigger/include/trigger/Issues.hpp 
 TLVL_FILE_SIZE: dfmodules/plugins/HDF5DataStore.hpp
 TLVL_FRAGMENT_HEADER_DUMP: dfmodules/plugins/DataWriter.cpp 
 TLVL_GENERATION: trigger/include/trigger/Issues.hpp
 TLVL_HOUSEKEEPING: readout/include/readout/ReadoutLogging.hpp
 TLVL_LIST_GENERATION: listrev/plugins/RandomDataListGenerator.cpp
 TLVL_LIST_REVERSAL: listrev/plugins/ListReverser.cpp
 TLVL_LIST_VALIDATION: listrev/plugins/ReversedListValidator.cpp
 TLVL_LOG: logging/include/logging/detail/Logger.hxx
 TLVL_QUEUE_POP: readout/include/readout/ReadoutLogging.hpp
 TLVL_QUEUE_PUSH: readout/include/readout/ReadoutLogging.hpp 
 TLVL_TAKE_NOTE: flxlibs/src/ElinkModel.hpp
 TLVL_TAKE_NOTE: readout/include/readout/ReadoutLogging.hpp
 TLVL_WORK_STEPS: dfmodules/plugins/DataWriter.cpp
 TLVL_WORK_STEPS: dfmodules/plugins/TriggerRecordBuilder.cpp 
 TLVL_WORK_STEPS: dfmodules/src/TriggerDecisionForwarder.cpp 
 TLVL_WORK_STEPS: dfmodules/src/TriggerInhibitAgent.cpp
 TLVL_WORK_STEPS: flxlibs/plugins/FelixCardReader.cpp
 TLVL_WORK_STEPS: flxlibs/src/CardWrapper.cpp
 TLVL_WORK_STEPS: readout/include/readout/ReadoutLogging.hpp

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the repeated trace-level constants in logging/detail/Logger.hxx, readout/include/readout/ReadoutLogging.hpp, trigger/include/trigger/Issues.hpp, and the other listed files. Determine which constants are genuinely common and where a shared definition belongs. Done means the agreed common constants are centralized without duplicated definitions across the listed packages.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
observability-sre
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.