ResourcesMonitoringHelper.cxx

Go to the documentation of this file.

// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
 
#include "ResourcesMonitoringHelper.h"
#include "Framework/DeviceMetricsInfo.h"
#define BOOST_BIND_GLOBAL_PLACEHOLDERS
#include <boost/property_tree/json_parser.hpp>
#include <fstream>
#include <string_view>
#include <algorithm>
#include <cassert>
#include <regex>
 
using namespace o2::framework;
 
template <typename T>
inline static T retriveValue(T val)
{
  return val;
}
 
inline static std::string retriveValue(const std::reference_wrapper<const StringMetric> val)
{
  return std::string(val.get().data);
}
 
template <typename T, typename TIMESTAMPS>
boost::property_tree::ptree fillNodeWithValue(const DeviceMetricsInfo& deviceMetrics,
                                              const T& metricsStorage, const TIMESTAMPS& timestampsStorage, size_t labelIndex, size_t storeIndex)
{
  unsigned int loopRange = std::min(deviceMetrics.metrics[labelIndex].filledMetrics, metricsStorage[storeIndex].size());
  boost::property_tree::ptree metricNode;
 
  for (unsigned int idx = 0; idx < loopRange; ++idx) {
    boost::property_tree::ptree values;
    values.add("timestamp", timestampsStorage[storeIndex][idx]);
    if constexpr (std::is_arithmetic_v<T>) {
      values.add("value", std::to_string(retriveValue(std::cref(metricsStorage[storeIndex][idx]))));
    } else {
      values.add("value", retriveValue(std::cref(metricsStorage[storeIndex][idx])));
    }
    metricNode.push_back(std::make_pair("", values));
  }
  return metricNode;
}
 
bool ResourcesMonitoringHelper::dumpMetricsToJSON(const std::vector<DeviceMetricsInfo>& metrics,
                                                  const DeviceMetricsInfo& driverMetrics,
                                                  const std::vector<DeviceSpec>& specs,
                                                  std::vector<std::regex> const& performanceMetricsRegex) noexcept
{
 
  assert(metrics.size() == specs.size());
 
  if (metrics.empty()) {
    return false;
  }
 
  boost::property_tree::ptree root;
  for (unsigned int idx = 0; idx < metrics.size(); ++idx) {
 
    const auto& deviceMetrics = metrics[idx];
    boost::property_tree::ptree deviceRoot;
 
    for (size_t mi = 0; mi < deviceMetrics.metricLabels.size(); mi++) {
      std::string_view metricLabel{deviceMetrics.metricLabels[mi].label, deviceMetrics.metricLabels[mi].size};
 
      auto same = [metricLabel](std::regex const& matcher) -> bool {
        return std::regex_match(metricLabel.begin(), metricLabel.end(), matcher);
      };
      //check if we are interested
      if (std::find_if(std::begin(performanceMetricsRegex), std::end(performanceMetricsRegex), same) == performanceMetricsRegex.end()) {
        continue;
      }
      auto storeIdx = deviceMetrics.metrics[mi].storeIdx;
 
      if (deviceMetrics.metrics[mi].filledMetrics == 0) {
        continue;
      }
      //if so
 
      boost::property_tree::ptree metricNode;
 
      switch (deviceMetrics.metrics[mi].type) {
        case MetricType::Int:
          metricNode = fillNodeWithValue(deviceMetrics, deviceMetrics.intMetrics, deviceMetrics.intTimestamps, mi, storeIdx);
          break;
 
        case MetricType::Float:
          metricNode = fillNodeWithValue(deviceMetrics, deviceMetrics.floatMetrics, deviceMetrics.floatTimestamps, mi, storeIdx);
          break;
 
        case MetricType::String:
          metricNode = fillNodeWithValue(deviceMetrics, deviceMetrics.stringMetrics, deviceMetrics.stringTimestamps, mi, storeIdx);
          break;
 
        case MetricType::Uint64:
          metricNode = fillNodeWithValue(deviceMetrics, deviceMetrics.uint64Metrics, deviceMetrics.uint64Timestamps, mi, storeIdx);
          break;
 
        default:
          continue;
      }
      deviceRoot.add_child(std::string(metricLabel), metricNode);
    }
 
    root.add_child(specs[idx].id, deviceRoot);
  }
 
  boost::property_tree::ptree driverRoot;
  for (size_t mi = 0; mi < driverMetrics.metricLabels.size(); mi++) {
    std::string_view const metricLabel{driverMetrics.metricLabels[mi].label, driverMetrics.metricLabels[mi].size};
    auto same = [metricLabel](std::regex const& matcher) -> bool {
      return std::regex_match(metricLabel.begin(), metricLabel.end(), matcher);
    };
 
    //check if we are interested
    if (std::find_if(std::begin(performanceMetricsRegex), std::end(performanceMetricsRegex), same) == performanceMetricsRegex.end()) {
      continue;
    }
 
    auto storeIdx = driverMetrics.metrics[mi].storeIdx;
    // and if data is there
    if (driverMetrics.metrics[mi].filledMetrics == 0) {
      continue;
    }
 
    //if so
    boost::property_tree::ptree metricNode;
 
    switch (driverMetrics.metrics[mi].type) {
      case MetricType::Int:
        metricNode = fillNodeWithValue(driverMetrics, driverMetrics.intMetrics, driverMetrics.intTimestamps, mi, storeIdx);
        break;
 
      case MetricType::Float:
        metricNode = fillNodeWithValue(driverMetrics, driverMetrics.floatMetrics, driverMetrics.floatTimestamps, mi, storeIdx);
        break;
 
      case MetricType::String:
        metricNode = fillNodeWithValue(driverMetrics, driverMetrics.stringMetrics, driverMetrics.stringTimestamps, mi, storeIdx);
        break;
 
      case MetricType::Uint64:
        metricNode = fillNodeWithValue(driverMetrics, driverMetrics.uint64Metrics, driverMetrics.uint64Timestamps, mi, storeIdx);
        break;
 
      default:
        continue;
    }
    driverRoot.add_child(std::string{metricLabel}, metricNode);
  }
 
  root.add_child("driver", driverRoot);
 
  std::ofstream file("performanceMetrics.json", std::ios::out);
  if (file.is_open()) {
    boost::property_tree::json_parser::write_json(file, root);
  } else {
    return false;
  }
 
  file.close();
 
  return true;
}