top::AnalysisTrackingHelper Class Reference

Helper for collecting data for analysis tracking. More...

#include <AnalysisTrackingHelper.h>

Collaboration diagram for top::AnalysisTrackingHelper:

Classes
struct	InputFileInfo

Public Member Functions
	AnalysisTrackingHelper ()
	~AnalysisTrackingHelper ()
void	addInputFile (std::string const &path, unsigned long long entriesProcessed)
	Notify helper that an input file was processed. More...
void	setTopConfig (std::shared_ptr< TopConfig > const &topConfig)
	Notify helper about configuration options. More...
void	writeTree (std::string const &treename)
	Store tracking data in current TFile. More...

Private Member Functions
void	finish ()

Private Attributes
std::string	m_json
bool	m_finished
std::shared_ptr< TopConfig >	m_topConfig
std::vector< InputFileInfo >	m_inputFiles

Detailed Description

Helper for collecting data for analysis tracking.

Definition at line 20 of file AnalysisTrackingHelper.h.

Constructor & Destructor Documentation

AnalysisTrackingHelper()

top::AnalysisTrackingHelper::AnalysisTrackingHelper

(

)

Definition at line 59 of file AnalysisTrackingHelper.cxx.

                                                 :
    m_finished(false)
  { }

~AnalysisTrackingHelper()

top::AnalysisTrackingHelper::~AnalysisTrackingHelper

(

)

Definition at line 64 of file AnalysisTrackingHelper.cxx.

{ }

Member Function Documentation

addInputFile()

void top::AnalysisTrackingHelper::addInputFile	(	std::string const &	path,
		unsigned long long	entriesProcessed
	)

Notify helper that an input file was processed.

Parameters

path	Path to the input file.
entriesProcessed	Number of entries that were processed.

Definition at line 67 of file AnalysisTrackingHelper.cxx.

                                                                                                      {
    top::check(!m_finished, "AnalysisTrackingHelper::addInputFile called on finished instance");
    char* fullpath = realpath(path.c_str(), NULL);
    BOOST_SCOPE_EXIT(fullpath) {
      free(fullpath);
    } BOOST_SCOPE_EXIT_END
    m_inputFiles.emplace_back((fullpath == nullptr ? path.c_str() : fullpath), entriesProcessed);
  }

finish()

void top::AnalysisTrackingHelper::finish ( )

private

Definition at line 91 of file AnalysisTrackingHelper.cxx.

                                      {
    std::ostringstream out;
 
    std::string const json_null("null");
    out << "{\n";
    {
      // Store settings from configuration file:
      out << json_dump("configSettings") << ": {";
      auto const& config = *top::ConfigurationSettings::get();
      char const* sep = "\n ";
      for (auto&& kv : config.stringData()) {
        if (!kv.second.m_set) continue;
        out << sep << json_dump(kv.first) << ": " << json_dump(kv.second.m_data);
        sep = ",\n ";
      }
      out << "},\n";
    }
    {
      // Store small subset of environment variables:
      out << json_dump("environment") << ": {";
      char const* sep = "\n ";
      auto dumpEnvVar = [&](char const* name) {
                          char const* value = std::getenv(name);
 
                          out << sep << json_dump(name) << ": " << (value == nullptr ? json_null : json_dump(value));
                          sep = ",\n ";
                        };
      dumpEnvVar("AnalysisBase_DIR");
      dumpEnvVar("AnalysisBase_VERSION");
      dumpEnvVar("AnalysisBaseExternals_DIR");
      dumpEnvVar("AnalysisBaseExternals_VERSION");
      dumpEnvVar("AnalysisTop_DIR");
      dumpEnvVar("AnalysisTop_VERSION");
      dumpEnvVar("AtlasVersion");
      dumpEnvVar("HOSTNAME");
      dumpEnvVar("PanDA_TaskID");
      dumpEnvVar("PandaID");
      out << "},\n";
    }
    {
      // Store metadata of inputs:
      out << json_dump("inputConfig") << ": {\n";
      out << " " << json_dump("derivationFormat") << ": " << json_dump(m_topConfig->getDerivationStream()) << ",\n";
      out << " " << json_dump("dsid") << ": " << json_dump(m_topConfig->getDSID()) << ",\n";
      out << " " << json_dump("isMC") << ": " << json_dump(m_topConfig->isMC()) << ",\n";
      out << " " << json_dump("isAtlFast2") << ": " << json_dump(m_topConfig->isAFII()) << "\n";
      out << " " << json_dump("BtagCDIPath") << ": " << json_dump(m_topConfig->bTaggingCDIPath()) << "\n";
      out << "},\n";
    }
    {
      // List paths of loaded libraries, grouping them by directory:
      bool ok;
      std::map<std::string, std::set<std::string> > libs;
      try {
        boost::regex reLine("\\s*(?:\\S+\\s+){5}(/.*)");
        boost::cmatch m;
        std::ifstream stream("/proc/self/maps", std::ios_base::in | std::ios_base::binary);
        for (std::string line; std::getline(stream, line); ) {
          if (boost::regex_match(line.c_str(), m, reLine)) {
            std::string const& path = m[1];
            size_t i = path.rfind('/');
            assert(i != std::string::npos);
            std::string const& basename = path.substr(i + 1);
            if (basename.starts_with( "lib")) {
              std::string dirpath = path.substr(0, (i ? i : 1));
              libs[dirpath].insert(basename);
            }
          }
        }
        stream.close();
        ok = true;
      }
      catch (std::exception const&) {
        ok = false;
      }
      // Store sorted list of loaded libraries (if listing was successful):
      if (ok) {
        out << json_dump("images") << ": [";
        char const* sep1 = "\n ";
        for (auto&& lib : libs) {
          out << sep1 << "[" << json_dump(lib.first) << ", [";
          sep1 = ",\n ";
          char const* sep2 = "\n  ";
          for (auto&& basename : lib.second) {
            out << sep2 << json_dump(basename);
            sep2 = ",\n  ";
          }
          out << "]]";
        }
        out << "],\n";
      }
    }
    {
      // Store information about processed input files:
      out << json_dump("inputFiles") << ": [";
      char const* sep = "\n ";
      for (auto const& inputFile : m_inputFiles) {
        out << sep << "[" << json_dump(inputFile.path) << "," << json_dump(inputFile.entriesProcessed) << "]";
        sep = ",\n ";
      }
      out << "],\n";
    }
    {
      // Store various PerfStats:
      auto&& readStats = xAOD::IOStats::instance().stats();
      out << json_dump("perfStats") << ": {\n";
      {
        out << " " << json_dump("readEntriesByContainer") << ": {";
        char const* sep = "\n  ";
        for (auto&& kv : readStats.containers()) {
          xAOD::BranchStats const& bs = kv.second;
          if (std::string(bs.GetName()).ends_with("TDS") || std::string(bs.GetName()).ends_with("Aux.")) continue;
          if (bs.readEntries()) {
            out << sep << json_dump(bs.GetName()) << ": " << json_dump(bs.readEntries());
            sep = ",\n  ";
          }
        }
        out << "},\n";
      }
      {
        out << " " << json_dump("readEntriesByBranch") << ": {";
        char const* sep = "\n  ";
        for (auto&& kv : readStats.branches()) {
          for (xAOD::BranchStats const* bs : kv.second) {
            if (bs && bs->readEntries()) {
              out << sep << json_dump(bs->GetName()) << ": " << json_dump(bs->readEntries());
              sep = ",\n  ";
            }
          }
        }
        out << "},\n";
      }
      out << " " << json_dump("totalEntries") << ": " << json_dump(readStats.nEvents()) << "},\n";
    }
    {
      // Store configuration of all (CP) tools:
      out << json_dump("toolConfig") << ": {";
      PropertyValueJsonDumper json_dump_prop;
      char const* toolsep = "\n ";
      for (std::string const& toolname : listToolStore()) {
        auto&& tool = asg::ToolStore::get<asg::AsgTool>(toolname);
        if (tool == nullptr) continue;
        if (tool->name().starts_with( "top::")) continue;
        out << toolsep << json_dump(tool->name()) << ": {";
        auto&& props = *tool->getPropertyMgr();
        char const* propsep = "\n  ";
        for (auto&& prop : props.getProperties()) {
          if (!prop.second->isValid()) continue;
          auto&& jvalue = json_dump_prop(prop.second);
          if (jvalue == std::nullopt) continue;
          out << propsep << json_dump(prop.first) << ": " << *jvalue;
          propsep = ",\n  ";
        }
        out << "}";
        toolsep = ",\n ";
      }
      out << "},\n";
    }
    out << json_dump("format") << ": " << json_dump(1) << "\n}\n";
    out.str().swap(m_json);
    m_finished = true;
  }

setTopConfig()

void top::AnalysisTrackingHelper::setTopConfig

(

std::shared_ptr< TopConfig > const &

topConfig

)

Notify helper about configuration options.

Parameters

topConfig

Pointer to the TopConfig object.

Definition at line 76 of file AnalysisTrackingHelper.cxx.

                                                                                        {
    top::check(!m_finished, "AnalysisTrackingHelper::setTopConfig called on finished instance");
    m_topConfig = topConfig;
  }

writeTree()

void top::AnalysisTrackingHelper::writeTree

(

std::string const &

treename

)

Store tracking data in current TFile.

Parameters

treename

Name of the TTree used to store the data.

Remarks

It's your responsibility to call TFile::cd() before this function.

Definition at line 81 of file AnalysisTrackingHelper.cxx.

                                                                  {
    finish();
    TTree* t = new TTree(treename.c_str(), "");
    t->SetAutoSave(0);
    t->SetAutoFlush(0);
    t->Branch("jsonData", &m_json, 262144);
    t->Fill();
    t->Write();
  }

Member Data Documentation

m_finished

bool top::AnalysisTrackingHelper::m_finished

private

Definition at line 63 of file AnalysisTrackingHelper.h.

m_inputFiles

std::vector<InputFileInfo> top::AnalysisTrackingHelper::m_inputFiles

private

Definition at line 65 of file AnalysisTrackingHelper.h.

m_json

std::string top::AnalysisTrackingHelper::m_json

private

Definition at line 62 of file AnalysisTrackingHelper.h.

m_topConfig

std::shared_ptr<TopConfig> top::AnalysisTrackingHelper::m_topConfig

private

Definition at line 64 of file AnalysisTrackingHelper.h.

---

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

• AnalysisTrackingHelper.h
• AnalysisTrackingHelper.cxx