system_metrics.hpp File Reference

#include "shambase/aliases_float.hpp"
#include "shambase/memory.hpp"
#include "shamcmdopt/env.hpp"
#include <memory>
#include <optional>

Include dependency graph for system_metrics.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	shamsys::ISystemMetricReporter
struct	shamsys::SystemMetrics
struct	shamsys::FormattedSystemMetrics

Namespaces
namespace	shamsys
	namespace for the system handling

Functions
std::unique_ptr< ISystemMetricReporter > &	shamsys::current_reporter ()
std::optional< f64 >	shamsys::get_rank_energy_consummed ()
bool	shamsys::support_rank_energy_consummed ()
std::optional< f64 >	shamsys::get_gpu_energy_consummed ()
bool	shamsys::support_gpu_energy_consummed ()
std::optional< f64 >	shamsys::get_cpu_energy_consummed ()
bool	shamsys::support_cpu_energy_consummed ()
std::optional< f64 >	shamsys::get_dram_energy_consummed ()
bool	shamsys::support_dram_energy_consummed ()
SystemMetrics	shamsys::get_system_metrics (bool barrier=true)
std::vector< SystemMetrics >	shamsys::gather_rank_metrics (const SystemMetrics &input)
SystemMetrics	shamsys::aggregate_rank_metrics (const std::vector< SystemMetrics > &input)
FormattedSystemMetrics	shamsys::format_system_metrics (const SystemMetrics &input)
	Only to be used on deltas, not the raw one.
SystemMetrics	shamsys::operator- (const SystemMetrics &lhs, const SystemMetrics &rhs)
bool	shamsys::has_reporter ()

Variables
std::optional< std::string >	SHAM_SYSTEM_METRICS_REPORTER

Detailed Description

Author

Timothée David–Cléris (tim.s.nosp@m.hamr.nosp@m.ock@p.nosp@m.roto.nosp@m.n.me)

Definition in file system_metrics.hpp.

Variable Documentation

SHAM_SYSTEM_METRICS_REPORTER

std::optional<std::string> SHAM_SYSTEM_METRICS_REPORTER

inline

Initial value:

= shamcmdopt::getenv_str_register(
    "SHAM_SYSTEM_METRICS_REPORTER", "The name of the system metrics reporter to use")

Definition at line 24 of file system_metrics.hpp.