Centralized metrics collection for the entire pipeline. More...

#include <pipeline_metrics.h>

Collaboration diagram for kcenon::pacs::network::pipeline::pipeline_metrics:

Public Member Functions
	pipeline_metrics ()=default
	Default constructor.

	pipeline_metrics (const pipeline_metrics &)=delete

pipeline_metrics &	operator= (const pipeline_metrics &)=delete

	pipeline_metrics (pipeline_metrics &&)=delete

pipeline_metrics &	operator= (pipeline_metrics &&)=delete

auto	get_stage_metrics (pipeline_stage stage) noexcept -> stage_metrics &
	Get metrics for a specific stage.

auto	get_stage_metrics (pipeline_stage stage) const noexcept -> const stage_metrics &
	Get metrics for a specific stage (const)

void	record_stage_completion (pipeline_stage stage, uint64_t processing_time_ns, bool success) noexcept
	Record a stage job completion.

void	increment_stage_queue (pipeline_stage stage) noexcept
	Increment queued job count for a stage.

void	decrement_stage_queue (pipeline_stage stage) noexcept
	Decrement queued job count for a stage.

auto	get_category_metrics (job_category category) noexcept -> category_metrics &
	Get metrics for a specific category.

auto	get_category_metrics (job_category category) const noexcept -> const category_metrics &
	Get metrics for a specific category (const)

void	record_operation_completion (job_category category, uint64_t latency_ns, bool success) noexcept
	Record an operation completion.

auto	get_total_operations () const noexcept -> uint64_t
	Get total operations processed.

auto	get_active_associations () const noexcept -> uint32_t
	Get current number of active associations.

void	increment_active_associations () noexcept
	Increment active association count.

void	decrement_active_associations () noexcept
	Decrement active association count.

auto	get_peak_associations () const noexcept -> uint32_t
	Get peak concurrent associations.

void	reset () noexcept
	Reset all metrics.

void	mark_start_time () noexcept
	Mark the start time for throughput calculation.

auto	get_throughput_per_second (job_category category) const noexcept -> double
	Calculate throughput for a category (operations per second)

Static Public Attributes
static constexpr size_t	stage_count
	Number of pipeline stages.

static constexpr size_t	category_count = 8
	Number of job categories.

Private Attributes
std::array< stage_metrics, stage_count >	stage_metrics_

std::array< category_metrics, category_count >	category_metrics_

std::atomic< uint64_t >	total_operations_ {0}

std::atomic< uint32_t >	active_associations_ {0}

std::atomic< uint32_t >	peak_associations_ {0}

std::chrono::steady_clock::time_point	start_time_ {std::chrono::steady_clock::now()}

Detailed Description

Centralized metrics collection for the entire pipeline.

Provides thread-safe metrics collection with minimal overhead using atomic operations and relaxed memory ordering where safe.

Definition at line 204 of file pipeline_metrics.h.

Constructor & Destructor Documentation

◆ pipeline_metrics() [1/3]

kcenon::pacs::network::pipeline::pipeline_metrics::pipeline_metrics ( )

default

Default constructor.

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/metrics/pipeline_metrics.h.

◆ pipeline_metrics() [2/3]

kcenon::pacs::network::pipeline::pipeline_metrics::pipeline_metrics ( const pipeline_metrics & )

delete

◆ pipeline_metrics() [3/3]

kcenon::pacs::network::pipeline::pipeline_metrics::pipeline_metrics ( pipeline_metrics && )

delete

Member Function Documentation

◆ decrement_active_associations()

void kcenon::pacs::network::pipeline::pipeline_metrics::decrement_active_associations ( )

inlinenoexcept

Decrement active association count.

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/metrics/pipeline_metrics.h.

Definition at line 344 of file pipeline_metrics.h.

                                                  {
        active_associations_.fetch_sub(1, std::memory_order_relaxed);
    }

References active_associations_.

◆ decrement_stage_queue()

void kcenon::pacs::network::pipeline::pipeline_metrics::decrement_stage_queue ( pipeline_stage stage )

inlinenoexcept

Decrement queued job count for a stage.

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/metrics/pipeline_metrics.h.

Definition at line 269 of file pipeline_metrics.h.

                                                              {
        stage_metrics_[static_cast<size_t>(stage)].jobs_queued.fetch_sub(
            1, std::memory_order_relaxed);
    }

References stage_metrics_.

◆ get_active_associations()

auto kcenon::pacs::network::pipeline::pipeline_metrics::get_active_associations ( ) const -> uint32_t

inlinenodiscardnoexcept

Get current number of active associations.

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/metrics/pipeline_metrics.h.

Definition at line 323 of file pipeline_metrics.h.

                                                                            {
        return active_associations_.load(std::memory_order_relaxed);
    }

References active_associations_.

◆ get_category_metrics() [1/2]

auto kcenon::pacs::network::pipeline::pipeline_metrics::get_category_metrics ( job_category category ) const -> const category_metrics&

inlinenodiscardnoexcept

Get metrics for a specific category (const)

Definition at line 291 of file pipeline_metrics.h.

                                   {
        return category_metrics_[static_cast<size_t>(category)];
    }

References category_metrics_.

◆ get_category_metrics() [2/2]

auto kcenon::pacs::network::pipeline::pipeline_metrics::get_category_metrics ( job_category category ) -> category_metrics&

inlinenodiscardnoexcept

Get metrics for a specific category.

Parameters

category The job category

Returns: Reference to the category metrics

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/metrics/pipeline_metrics.h.

Definition at line 283 of file pipeline_metrics.h.

                             {
        return category_metrics_[static_cast<size_t>(category)];
    }

References category_metrics_.

◆ get_peak_associations()

auto kcenon::pacs::network::pipeline::pipeline_metrics::get_peak_associations ( ) const -> uint32_t

inlinenodiscardnoexcept

Get peak concurrent associations.

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/metrics/pipeline_metrics.h.

Definition at line 351 of file pipeline_metrics.h.

                                                                          {
        return peak_associations_.load(std::memory_order_relaxed);
    }

References peak_associations_.

◆ get_stage_metrics() [1/2]

auto kcenon::pacs::network::pipeline::pipeline_metrics::get_stage_metrics ( pipeline_stage stage ) const -> const stage_metrics&

inlinenodiscardnoexcept

Get metrics for a specific stage (const)

Definition at line 241 of file pipeline_metrics.h.

                                {
        return stage_metrics_[static_cast<size_t>(stage)];
    }

References stage_metrics_.

◆ get_stage_metrics() [2/2]

auto kcenon::pacs::network::pipeline::pipeline_metrics::get_stage_metrics ( pipeline_stage stage ) -> stage_metrics&

inlinenodiscardnoexcept

Get metrics for a specific stage.

Parameters

stage The pipeline stage

Returns: Reference to the stage metrics

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/metrics/pipeline_metrics.h.

Definition at line 233 of file pipeline_metrics.h.

                          {
        return stage_metrics_[static_cast<size_t>(stage)];
    }

References stage_metrics_.

◆ get_throughput_per_second()

auto kcenon::pacs::network::pipeline::pipeline_metrics::get_throughput_per_second ( job_category category ) const -> double

inlinenodiscardnoexcept

Calculate throughput for a category (operations per second)

Parameters

category The job category

Returns: Operations per second since start_time

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/metrics/pipeline_metrics.h.

Definition at line 385 of file pipeline_metrics.h.

                  {
        auto elapsed = std::chrono::steady_clock::now() - start_time_;
        auto seconds = std::chrono::duration<double>(elapsed).count();
        if (seconds <= 0.0) {
            return 0.0;
        }
        return static_cast<double>(
            category_metrics_[static_cast<size_t>(category)]
                .total_operations.load(std::memory_order_relaxed)) / seconds;
    }

References category_metrics_, and start_time_.

◆ get_total_operations()

auto kcenon::pacs::network::pipeline::pipeline_metrics::get_total_operations ( ) const -> uint64_t

inlinenodiscardnoexcept

Get total operations processed.

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/metrics/pipeline_metrics.h.

Definition at line 316 of file pipeline_metrics.h.

                                                                         {
        return total_operations_.load(std::memory_order_relaxed);
    }

References total_operations_.

◆ increment_active_associations()

void kcenon::pacs::network::pipeline::pipeline_metrics::increment_active_associations ( )

inlinenoexcept

Increment active association count.

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/metrics/pipeline_metrics.h.

Definition at line 330 of file pipeline_metrics.h.

                                                  {
        uint32_t current = active_associations_.fetch_add(1, std::memory_order_relaxed);
        // Update peak if necessary
        uint32_t peak = peak_associations_.load(std::memory_order_relaxed);
        while (current + 1 > peak &&
               !peak_associations_.compare_exchange_weak(
                   peak, current + 1,
                   std::memory_order_relaxed, std::memory_order_relaxed)) {
        }
    }

References active_associations_, and peak_associations_.

◆ increment_stage_queue()

void kcenon::pacs::network::pipeline::pipeline_metrics::increment_stage_queue ( pipeline_stage stage )

inlinenoexcept

Increment queued job count for a stage.

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/metrics/pipeline_metrics.h.

Definition at line 261 of file pipeline_metrics.h.

                                                              {
        stage_metrics_[static_cast<size_t>(stage)].jobs_queued.fetch_add(
            1, std::memory_order_relaxed);
    }

References stage_metrics_.

◆ mark_start_time()

void kcenon::pacs::network::pipeline::pipeline_metrics::mark_start_time ( )

inlinenoexcept

Mark the start time for throughput calculation.

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/metrics/pipeline_metrics.h.

Definition at line 376 of file pipeline_metrics.h.

                                    {
        start_time_ = std::chrono::steady_clock::now();
    }

References start_time_.

Referenced by kcenon::pacs::network::pipeline::pipeline_coordinator::reset_metrics().

Here is the caller graph for this function:

◆ operator=() [1/2]

pipeline_metrics & kcenon::pacs::network::pipeline::pipeline_metrics::operator= ( const pipeline_metrics & )

delete

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/metrics/pipeline_metrics.h.

◆ operator=() [2/2]

pipeline_metrics & kcenon::pacs::network::pipeline::pipeline_metrics::operator= ( pipeline_metrics && )

delete

◆ record_operation_completion()

void kcenon::pacs::network::pipeline::pipeline_metrics::record_operation_completion	(	job_category	category,
		uint64_t	latency_ns,
		bool	success )

inlinenoexcept

Record an operation completion.

Parameters

category	The job category
latency_ns	End-to-end latency in nanoseconds
success	Whether the operation succeeded

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/metrics/pipeline_metrics.h.

Definition at line 302 of file pipeline_metrics.h.

                                                            {
        category_metrics_[static_cast<size_t>(category)]
            .record_operation(latency_ns, success);
        total_operations_.fetch_add(1, std::memory_order_relaxed);
    }

References category_metrics_, kcenon::pacs::network::pipeline::success, and total_operations_.

◆ record_stage_completion()

void kcenon::pacs::network::pipeline::pipeline_metrics::record_stage_completion	(	pipeline_stage	stage,
		uint64_t	processing_time_ns,
		bool	success )

inlinenoexcept

Record a stage job completion.

Parameters

stage	The pipeline stage
processing_time_ns	Processing time in nanoseconds
success	Whether the job succeeded

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/metrics/pipeline_metrics.h.

Definition at line 252 of file pipeline_metrics.h.

                                                        {
        stage_metrics_[static_cast<size_t>(stage)]
            .record_job_completion(processing_time_ns, success);
    }

References stage_metrics_, and kcenon::pacs::network::pipeline::success.

◆ reset()

void kcenon::pacs::network::pipeline::pipeline_metrics::reset ( )

inlinenoexcept

Reset all metrics.

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/network/pipeline/metrics/pipeline_metrics.h.

Definition at line 362 of file pipeline_metrics.h.

                          {
        for (auto& stage : stage_metrics_) {
            stage.reset();
        }
        for (auto& category : category_metrics_) {
            category.reset();
        }
        total_operations_.store(0, std::memory_order_relaxed);
        peak_associations_.store(0, std::memory_order_relaxed);
    }