kcenon::monitoring::performance_benchmark Class Reference

Performance benchmark utility. More...

#include <performance_monitor.h>

Collaboration diagram for kcenon::monitoring::performance_benchmark:

Public Member Functions
	performance_benchmark (const std::string &name)
void	set_iterations (std::uint32_t iterations)
	Set number of benchmark iterations.
void	set_warmup_iterations (std::uint32_t warmup)
	Set number of warmup iterations.
template<typename Func >
common::Result< performance_metrics >	run (const std::string &operation_name, Func &&func)
	Run a benchmark.
template<typename Func1 , typename Func2 >
common::Result< std::pair< performance_metrics, performance_metrics > >	compare (const std::string &operation1_name, Func1 &&func1, const std::string &operation2_name, Func2 &&func2)
	Compare two operations.

Private Attributes
performance_profiler	profiler_
std::string	name_
std::uint32_t	iterations_ {1000}
std::uint32_t	warmup_iterations_ {100}

Detailed Description

Performance benchmark utility.

Definition at line 627 of file performance_monitor.h.

Constructor & Destructor Documentation

performance_benchmark()

kcenon::monitoring::performance_benchmark::performance_benchmark ( const std::string & name )

inlineexplicit

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/core/performance_monitor.h.

Definition at line 635 of file performance_monitor.h.

        : name_(name) {}

Member Function Documentation

compare()

template<typename Func1 , typename Func2 >

common::Result< std::pair< performance_metrics, performance_metrics > > kcenon::monitoring::performance_benchmark::compare ( const std::string & operation1_name, Func1 && func1, const std::string & operation2_name, Func2 && func2 )

inline

Compare two operations.

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/core/performance_monitor.h.

Definition at line 697 of file performance_monitor.h.

      {
        auto result1 = run(operation1_name, std::forward<Func1>(func1));
        if (result1.is_err()) {
            return common::Result<std::pair<performance_metrics, performance_metrics>>::err(result1.error());
        }
 
        auto result2 = run(operation2_name, std::forward<Func2>(func2));
        if (result2.is_err()) {
            return common::Result<std::pair<performance_metrics, performance_metrics>>::err(result2.error());
        }
 
        return common::ok(std::make_pair(result1.value(), result2.value()));
    }

Referenced by TEST_F().

Here is the caller graph for this function:

run()

template<typename Func >

common::Result< performance_metrics > kcenon::monitoring::performance_benchmark::run ( const std::string & operation_name, Func && func )

inline

Run a benchmark.

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/core/performance_monitor.h.

Definition at line 658 of file performance_monitor.h.

      {
        // Warmup
        for (std::uint32_t i = 0; i < warmup_iterations_; ++i) {
            func();
        }
        
        // Actual benchmark
        for (std::uint32_t i = 0; i < iterations_; ++i) {
            auto start = std::chrono::high_resolution_clock::now();
            
            try {
                func();
            } catch (...) {
                // Record error
                auto end = std::chrono::high_resolution_clock::now();
                auto duration = std::chrono::duration_cast<std::chrono::nanoseconds>(
                    end - start
                );
                profiler_.record_sample(operation_name, duration, false);
                continue;
            }
            
            auto end = std::chrono::high_resolution_clock::now();
            auto duration = std::chrono::duration_cast<std::chrono::nanoseconds>(
                end - start
            );
            profiler_.record_sample(operation_name, duration, true);
        }
        
        return profiler_.get_metrics(operation_name);
    }

References kcenon::monitoring::performance_profiler::get_metrics(), and kcenon::monitoring::performance_profiler::record_sample().

Referenced by TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

set_iterations()

void kcenon::monitoring::performance_benchmark::set_iterations ( std::uint32_t iterations )

inline

Set number of benchmark iterations.

Parameters

iterations

Number of iterations to run during the benchmark

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/core/performance_monitor.h.

Definition at line 642 of file performance_monitor.h.

                                                {
        iterations_ = iterations;
    }

Referenced by TEST_F(), and TEST_F().

Here is the caller graph for this function:

set_warmup_iterations()

void kcenon::monitoring::performance_benchmark::set_warmup_iterations ( std::uint32_t warmup )

inline

Set number of warmup iterations.

Parameters

warmup

Number of warmup iterations to run before the benchmark

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/core/performance_monitor.h.

Definition at line 650 of file performance_monitor.h.

                                                   {
        warmup_iterations_ = warmup;
    }

Referenced by TEST_F(), and TEST_F().

Here is the caller graph for this function:

Member Data Documentation

iterations_

std::uint32_t kcenon::monitoring::performance_benchmark::iterations_ {1000}

private

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/core/performance_monitor.h.

Definition at line 631 of file performance_monitor.h.

{1000};

name_

std::string kcenon::monitoring::performance_benchmark::name_

private

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/core/performance_monitor.h.

Definition at line 630 of file performance_monitor.h.

profiler_

performance_profiler kcenon::monitoring::performance_benchmark::profiler_

private

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/core/performance_monitor.h.

Definition at line 629 of file performance_monitor.h.

warmup_iterations_

std::uint32_t kcenon::monitoring::performance_benchmark::warmup_iterations_ {100}

private

Examples

/home/runner/work/monitoring_system/monitoring_system/include/kcenon/monitoring/core/performance_monitor.h.

Definition at line 632 of file performance_monitor.h.

{100};

---

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

• include/kcenon/monitoring/core/performance_monitor.h