MetadataService Class Reference

This class provides a service for writing metadata about the basf2 execution and about output files to a json file. More...

#include <MetadataService.h>

Public Member Functions
void	setJsonFileName (const std::string &fileName)
	Set the name of the json metadata file.
void	addRootOutputFile (const std::string &fileName, const FileMetaData *metaData=nullptr)
	Add the metadata of a root output file.
void	addRootNtupleFile (const std::string &fileName)
	Add the metadata of a root ntuple file.
void	addHDF5File (const std::string &fileName)
	Add the metadata of a HDF5 file.
void	addBasf2Status (const std::string &message="")
	Add metadata of basf2 status.
void	addModuleCallsCount ()
	Add the metadata of number of calls of all modules.
void	finishBasf2 (bool success=true)
	Add metadata for basf2 completion.

Static Public Member Functions
static MetadataService &	Instance ()
	Static method to get a reference to the MetadataService instance.

Private Member Functions
	MetadataService ()
	Constructor.
	MetadataService (const MetadataService &)=delete
	Disable/Hide the copy constructor.
MetadataService &	operator= (const MetadataService &)=delete
	Disable/Hide the copy assignment operator.
void	writeJson ()
	Serialize the current json content to the json file.

Private Attributes
std::string	m_fileName
	The name of the json file.
nlohmann::json	m_json
	The json object.
double	m_basf2StartTime
	the start time of basf2

Detailed Description

This class provides a service for writing metadata about the basf2 execution and about output files to a json file.

Definition at line 27 of file MetadataService.h.

Constructor & Destructor Documentation

MetadataService()

MetadataService ( )

private

Constructor.

Definition at line 21 of file MetadataService.cc.

                                : m_basf2StartTime{Utils::getClock()}
{
  m_json["basf2_apiversion"] = 1;
}

Member Function Documentation

addBasf2Status()

void addBasf2Status

(

const std::string &

message = ""

)

Add metadata of basf2 status.

Definition at line 89 of file MetadataService.cc.

{
  if (m_fileName.empty()) return;
  auto& status = m_json["basf2_status"];
  status["elapsed_walltime_sec"] = (Utils::getClock() - m_basf2StartTime) / Unit::s;
  status["resident_memory_mb"] = Utils::getRssMemoryKB() / 1024;
  StoreObjPtr<ProcessStatistics> processStatistics("", DataStore::c_Persistent);
  if (processStatistics.isValid()) {
    const auto& stats = processStatistics->getGlobal();
    status["runs_processed"] = int(stats.getCalls(ModuleStatistics::EStatisticCounters::c_BeginRun));
    status["events_processed"] = int(stats.getCalls());
  }
  if ((status.count("total_events") == 0) || (status["total_events"] == 0)) {
    status["total_events"] = Environment::Instance().getNumberOfEvents();
  }
  status["fatals"] = LogSystem::Instance().getMessageCounter(LogConfig::c_Fatal);
  status["errors"] = LogSystem::Instance().getMessageCounter(LogConfig::c_Error);
  status["warnings"] = LogSystem::Instance().getMessageCounter(LogConfig::c_Warning);
  status["finished"] = false;
  status["message"] = message;
 
  writeJson();
}

addHDF5File()

void addHDF5File

(

const std::string &

fileName

)

Add the metadata of a HDF5 file.

Definition at line 75 of file MetadataService.cc.

{
  if (m_fileName.empty()) return;
  if (!FileSystem::isFile(fileName)) return;
 
  nlohmann::json file_json = {{"type", "HDF5"}, {"filename", fileName}};
 
  file_json["checksums"]["adler32"] = FileSystem::calculateAdler32(fileName);
 
  m_json["output_files"].push_back(file_json);
 
  writeJson();
}

addModuleCallsCount()

void addModuleCallsCount

(

)

Add the metadata of number of calls of all modules.

Definition at line 113 of file MetadataService.cc.

{
  if (m_fileName.empty()) return;
 
  StoreObjPtr<ProcessStatistics> processStatistics("", DataStore::c_Persistent);
 
  if (processStatistics.isValid()) {
 
    std::vector<ModuleStatistics> modulesSortedByIndex(processStatistics->getAll());
    sort(modulesSortedByIndex.begin(), modulesSortedByIndex.end(), [](const ModuleStatistics & a, const ModuleStatistics & b) { return a.getIndex() < b.getIndex(); });
 
    for (const ModuleStatistics& stats : modulesSortedByIndex) {
      m_json["modules_calls"][stats.getName()] = int(stats.getCalls(ModuleStatistics::EStatisticCounters::c_Event));
    }
  }
 
  writeJson();
}

addRootNtupleFile()

void addRootNtupleFile

(

const std::string &

fileName

)

Add the metadata of a root ntuple file.

Definition at line 57 of file MetadataService.cc.

{
  if (m_fileName.empty()) return;
  if (!FileSystem::isFile(fileName)) return;
 
  nlohmann::json file_json = {{"type", "RootNtuple"}, {"filename", fileName}};
 
  // no metadata and no check
 
  file_json["checksums"]["md5"] = FileSystem::calculateMD5(fileName);
  file_json["checksums"]["adler32"] = FileSystem::calculateAdler32(fileName);
  // no sha256 yet
 
  m_json["output_files"].push_back(file_json);
 
  writeJson();
}

addRootOutputFile()

void addRootOutputFile	(	const std::string &	fileName,
		const FileMetaData *	metaData = nullptr
	)

Add the metadata of a root output file.

Definition at line 32 of file MetadataService.cc.

{
  if (m_fileName.empty()) return;
  if (!FileSystem::isFile(fileName)) return;
 
  nlohmann::json file_json = {{"type", "RootOutput"}, {"filename", fileName}};
 
  if (metaData) {
    file_json["metadata"] = nlohmann::json::parse(metaData->getJsonStr());
  }
 
  try {
    std::string check = Utils::getCommandOutput("b2file-check", {"--json", fileName});
    file_json.merge_patch(nlohmann::json::parse(check));
  } catch (...) {}
 
  file_json["checksums"]["md5"] = FileSystem::calculateMD5(fileName);
  file_json["checksums"]["adler32"] = FileSystem::calculateAdler32(fileName);
  // no sha256 yet
 
  m_json["output_files"].push_back(file_json);
 
  writeJson();
}

finishBasf2()

void finishBasf2

(

bool

success = true

)

Add metadata for basf2 completion.

Definition at line 132 of file MetadataService.cc.

{
  m_json["basf2_status"]["finished"] = true;
  m_json["basf2_status"]["success"] = success;
 
  writeJson();
}

Instance()

MetadataService & Instance ( )

static

Static method to get a reference to the MetadataService instance.

Returns

A reference to an instance of this class.

Definition at line 26 of file MetadataService.cc.

{
  static MetadataService instance;
  return instance;
}

setJsonFileName()

void setJsonFileName ( const std::string &  fileName )

inline

Set the name of the json metadata file.

Parameters

fileName

name of the json file

Definition at line 43 of file MetadataService.h.

{m_fileName = fileName; writeJson();};

writeJson()

void writeJson ( )

private

Serialize the current json content to the json file.

Definition at line 140 of file MetadataService.cc.

{
  if (m_fileName.empty()) return;
  std::ofstream jsonFile(m_fileName.c_str());
  jsonFile << m_json.dump(2) << std::endl;
}

Member Data Documentation

m_basf2StartTime

double m_basf2StartTime

private

the start time of basf2

Definition at line 79 of file MetadataService.h.

m_fileName

std::string m_fileName

private

The name of the json file.

Definition at line 77 of file MetadataService.h.

m_json

nlohmann::json m_json

private

The json object.

Definition at line 78 of file MetadataService.h.

---

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

• framework/core/include/MetadataService.h
• framework/core/src/MetadataService.cc