Collector for DICOM storage and data transfer metrics. More...

#include <dicom_storage_collector.h>

Collaboration diagram for kcenon::pacs::monitoring::dicom_storage_collector:

Public Member Functions
	dicom_storage_collector (std::string ae_title="PACS_SCP")
	Default constructor.

	~dicom_storage_collector ()=default
	Destructor.

	dicom_storage_collector (const dicom_storage_collector &)=delete

dicom_storage_collector &	operator= (const dicom_storage_collector &)=delete

	dicom_storage_collector (dicom_storage_collector &&)=delete

dicom_storage_collector &	operator= (dicom_storage_collector &&)=delete

bool	initialize (const std::unordered_map< std::string, std::string > &config)
	Initialize the collector with configuration.

std::vector< storage_metric >	collect ()
	Collect current storage metrics.

std::string	get_name () const
	Get the collector name.

std::vector< std::string >	get_metric_types () const
	Get supported metric types.

bool	is_healthy () const
	Check if the collector is healthy.

std::unordered_map< std::string, double >	get_statistics () const
	Get collector statistics.

void	set_ae_title (std::string ae_title)
	Set the AE title for metric labels.

std::string	get_ae_title () const
	Get the current AE title.

void	set_pool_metrics_enabled (bool enabled)
	Enable or disable pool metrics collection.

bool	is_pool_metrics_enabled () const
	Check if pool metrics collection is enabled.

Private Member Functions
void	collect_transfer_metrics (std::vector< storage_metric > &metrics)

void	collect_pool_metrics (std::vector< storage_metric > &metrics)

storage_metric	create_metric (const std::string &name, double value, const std::string &type, const std::string &unit="") const

Private Attributes
std::string	ae_title_

bool	initialized_ {false}

bool	collect_pool_metrics_ {true}

std::mutex	stats_mutex_

std::uint64_t	collection_count_ {0}

std::chrono::steady_clock::time_point	init_time_

std::uint64_t	prev_bytes_sent_ {0}

std::uint64_t	prev_bytes_received_ {0}

std::chrono::steady_clock::time_point	prev_collection_time_

Detailed Description

Collector for DICOM storage and data transfer metrics.

This collector gathers metrics related to DICOM storage including:

Bytes sent/received over the network
Images stored/retrieved counts
Object pool statistics (element, dataset, PDU buffer pools)
Storage throughput calculations

Thread Safety: All public methods are thread-safe.

Definition at line 81 of file dicom_storage_collector.h.

Constructor & Destructor Documentation

◆ dicom_storage_collector() [1/3]

kcenon::pacs::monitoring::dicom_storage_collector::dicom_storage_collector ( std::string ae_title = "PACS_SCP" )

inlineexplicit

Default constructor.

Parameters

ae_title Optional AE title for labeling metrics

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/collectors/dicom_storage_collector.h.

Definition at line 205 of file dicom_storage_collector.h.

206 : ae_title_(std::move(ae_title)) {}

kcenon::pacs::monitoring::dicom_storage_collector::ae_title_

std::string ae_title_

Definition dicom_storage_collector.h:176

◆ ~dicom_storage_collector()

kcenon::pacs::monitoring::dicom_storage_collector::~dicom_storage_collector ( )

default

Destructor.

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/collectors/dicom_storage_collector.h.

◆ dicom_storage_collector() [2/3]

kcenon::pacs::monitoring::dicom_storage_collector::dicom_storage_collector ( const dicom_storage_collector & )

delete

◆ dicom_storage_collector() [3/3]

kcenon::pacs::monitoring::dicom_storage_collector::dicom_storage_collector ( dicom_storage_collector && )

delete

Member Function Documentation

◆ collect()

std::vector< storage_metric > kcenon::pacs::monitoring::dicom_storage_collector::collect ( )

inlinenodiscard

Collect current storage metrics.

Returns: Vector of storage metrics

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/collectors/dicom_storage_collector.h.

Definition at line 226 of file dicom_storage_collector.h.

                                                                  {
    std::vector<storage_metric> metrics;
 
    if (!initialized_) {
        return metrics;
    }
 
    // Collect transfer metrics
    collect_transfer_metrics(metrics);
 
    // Collect pool metrics if enabled
    if (collect_pool_metrics_) {
        collect_pool_metrics(metrics);
    }
 
    // Update statistics
    {
        std::lock_guard<std::mutex> lock(stats_mutex_);
        ++collection_count_;
    }
 
    return metrics;
}

References collect_pool_metrics(), collect_pool_metrics_, collect_transfer_metrics(), collection_count_, initialized_, and stats_mutex_.

Here is the call graph for this function:

◆ collect_pool_metrics()

void kcenon::pacs::monitoring::dicom_storage_collector::collect_pool_metrics ( std::vector< storage_metric > & metrics )

inlineprivate

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/collectors/dicom_storage_collector.h.

Definition at line 322 of file dicom_storage_collector.h.

                                        {
 
    const auto& pacs = pacs_metrics::global_metrics();
 
    // Element pool metrics
    const auto& element_pool = pacs.element_pool();
    metrics.push_back(create_metric(
        "dicom_element_pool_acquisitions_total",
        static_cast<double>(element_pool.total_acquisitions.load(std::memory_order_relaxed)),
        "counter",
        "count"));
    metrics.push_back(create_metric(
        "dicom_element_pool_hit_ratio",
        element_pool.hit_ratio(),
        "gauge",
        "ratio"));
    metrics.push_back(create_metric(
        "dicom_element_pool_size",
        static_cast<double>(element_pool.current_pool_size.load(std::memory_order_relaxed)),
        "gauge",
        "count"));
 
    // Dataset pool metrics
    const auto& dataset_pool = pacs.dataset_pool();
    metrics.push_back(create_metric(
        "dicom_dataset_pool_acquisitions_total",
        static_cast<double>(dataset_pool.total_acquisitions.load(std::memory_order_relaxed)),
        "counter",
        "count"));
    metrics.push_back(create_metric(
        "dicom_dataset_pool_hit_ratio",
        dataset_pool.hit_ratio(),
        "gauge",
        "ratio"));
    metrics.push_back(create_metric(
        "dicom_dataset_pool_size",
        static_cast<double>(dataset_pool.current_pool_size.load(std::memory_order_relaxed)),
        "gauge",
        "count"));
 
    // PDU buffer pool metrics
    const auto& pdu_pool = pacs.pdu_buffer_pool();
    metrics.push_back(create_metric(
        "dicom_pdu_buffer_pool_acquisitions_total",
        static_cast<double>(pdu_pool.total_acquisitions.load(std::memory_order_relaxed)),
        "counter",
        "count"));
    metrics.push_back(create_metric(
        "dicom_pdu_buffer_pool_hit_ratio",
        pdu_pool.hit_ratio(),
        "gauge",
        "ratio"));
    metrics.push_back(create_metric(
        "dicom_pdu_buffer_pool_size",
        static_cast<double>(pdu_pool.current_pool_size.load(std::memory_order_relaxed)),
        "gauge",
        "count"));
}

References create_metric(), and kcenon::pacs::monitoring::pacs_metrics::global_metrics().

Referenced by collect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ collect_transfer_metrics()

void kcenon::pacs::monitoring::dicom_storage_collector::collect_transfer_metrics ( std::vector< storage_metric > & metrics )

inlineprivate

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/collectors/dicom_storage_collector.h.

Definition at line 250 of file dicom_storage_collector.h.

                                        {
 
    const auto& transfer = pacs_metrics::global_metrics().transfer();
    const auto now = std::chrono::steady_clock::now();
 
    // Current values
    const auto bytes_sent = transfer.bytes_sent.load(std::memory_order_relaxed);
    const auto bytes_received = transfer.bytes_received.load(std::memory_order_relaxed);
    const auto images_stored = transfer.images_stored.load(std::memory_order_relaxed);
    const auto images_retrieved = transfer.images_retrieved.load(std::memory_order_relaxed);
 
    // Total bytes sent (counter)
    metrics.push_back(create_metric(
        "dicom_bytes_sent_total",
        static_cast<double>(bytes_sent),
        "counter",
        "bytes"));
 
    // Total bytes received (counter)
    metrics.push_back(create_metric(
        "dicom_bytes_received_total",
        static_cast<double>(bytes_received),
        "counter",
        "bytes"));
 
    // Images stored (counter)
    metrics.push_back(create_metric(
        "dicom_images_stored_total",
        static_cast<double>(images_stored),
        "counter",
        "count"));
 
    // Images retrieved (counter)
    metrics.push_back(create_metric(
        "dicom_images_retrieved_total",
        static_cast<double>(images_retrieved),
        "counter",
        "count"));
 
    // Calculate throughput rates
    const auto elapsed = std::chrono::duration_cast<std::chrono::milliseconds>(
        now - prev_collection_time_);
 
    if (elapsed.count() > 0) {
        // Bytes per second sent (gauge)
        const auto sent_delta = bytes_sent - prev_bytes_sent_;
        const double send_rate =
            static_cast<double>(sent_delta) * 1000.0 / static_cast<double>(elapsed.count());
        metrics.push_back(create_metric(
            "dicom_bytes_sent_rate",
            send_rate,
            "gauge",
            "bytes_per_second"));
 
        // Bytes per second received (gauge)
        const auto received_delta = bytes_received - prev_bytes_received_;
        const double receive_rate =
            static_cast<double>(received_delta) * 1000.0 / static_cast<double>(elapsed.count());
        metrics.push_back(create_metric(
            "dicom_bytes_received_rate",
            receive_rate,
            "gauge",
            "bytes_per_second"));
    }
 
    // Update previous values for next rate calculation
    prev_bytes_sent_ = bytes_sent;
    prev_bytes_received_ = bytes_received;
    prev_collection_time_ = now;
}

References create_metric(), kcenon::pacs::monitoring::pacs_metrics::global_metrics(), prev_bytes_received_, prev_bytes_sent_, prev_collection_time_, and kcenon::pacs::monitoring::pacs_metrics::transfer().

Referenced by collect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ create_metric()

storage_metric kcenon::pacs::monitoring::dicom_storage_collector::create_metric	(	const std::string &	name,
		double	value,
		const std::string &	type,
		const std::string &	unit = "" ) const

inlinenodiscardprivate

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/collectors/dicom_storage_collector.h.

Definition at line 451 of file dicom_storage_collector.h.

                                 {
    return storage_metric(
        name,
        value,
        type,
        unit,
        {{"ae", ae_title_}});
}

References ae_title_, and name.

Referenced by collect_pool_metrics(), and collect_transfer_metrics().

Here is the caller graph for this function:

◆ get_ae_title()

std::string kcenon::pacs::monitoring::dicom_storage_collector::get_ae_title ( ) const

inlinenodiscard

Get the current AE title.

Returns: The Application Entity title

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/collectors/dicom_storage_collector.h.

Definition at line 439 of file dicom_storage_collector.h.

                                                             {
    return ae_title_;
}

References ae_title_.

◆ get_metric_types()

std::vector< std::string > kcenon::pacs::monitoring::dicom_storage_collector::get_metric_types ( ) const

inlinenodiscard

Get supported metric types.

Returns: Vector of metric type names

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/collectors/dicom_storage_collector.h.

Definition at line 386 of file dicom_storage_collector.h.

                                                                            {
    std::vector<std::string> types = {
        // Transfer metrics
        "dicom_bytes_sent_total",
        "dicom_bytes_received_total",
        "dicom_images_stored_total",
        "dicom_images_retrieved_total",
        "dicom_bytes_sent_rate",
        "dicom_bytes_received_rate"
    };
 
    if (collect_pool_metrics_) {
        // Element pool
        types.push_back("dicom_element_pool_acquisitions_total");
        types.push_back("dicom_element_pool_hit_ratio");
        types.push_back("dicom_element_pool_size");
        // Dataset pool
        types.push_back("dicom_dataset_pool_acquisitions_total");
        types.push_back("dicom_dataset_pool_hit_ratio");
        types.push_back("dicom_dataset_pool_size");
        // PDU buffer pool
        types.push_back("dicom_pdu_buffer_pool_acquisitions_total");
        types.push_back("dicom_pdu_buffer_pool_hit_ratio");
        types.push_back("dicom_pdu_buffer_pool_size");
    }
 
    return types;
}

References collect_pool_metrics_.

◆ get_name()

std::string kcenon::pacs::monitoring::dicom_storage_collector::get_name ( ) const

inlinenodiscard

Get the collector name.

Returns: "dicom_storage_collector"

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/collectors/dicom_storage_collector.h.

Definition at line 382 of file dicom_storage_collector.h.

                                                         {
    return "dicom_storage_collector";
}

◆ get_statistics()

std::unordered_map< std::string, double > kcenon::pacs::monitoring::dicom_storage_collector::get_statistics ( ) const

inlinenodiscard

Get collector statistics.

Returns: Map of statistic name to value

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/collectors/dicom_storage_collector.h.

Definition at line 420 of file dicom_storage_collector.h.

                                              {
    std::lock_guard<std::mutex> lock(stats_mutex_);
 
    std::unordered_map<std::string, double> stats;
    stats["collection_count"] = static_cast<double>(collection_count_);
 
    if (initialized_) {
        const auto uptime = std::chrono::duration_cast<std::chrono::seconds>(
            std::chrono::steady_clock::now() - init_time_);
        stats["uptime_seconds"] = static_cast<double>(uptime.count());
    }
 
    return stats;
}

References collection_count_, init_time_, initialized_, and stats_mutex_.

◆ initialize()

bool kcenon::pacs::monitoring::dicom_storage_collector::initialize ( const std::unordered_map< std::string, std::string > & config )

inlinenodiscard

Initialize the collector with configuration.

Parameters

config Configuration map

Returns: true if initialization succeeded

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/collectors/dicom_storage_collector.h.

Definition at line 208 of file dicom_storage_collector.h.

                                                          {
    // Extract AE title from config if provided
    if (auto it = config.find("ae_title"); it != config.end()) {
        ae_title_ = it->second;
    }
 
    // Check for pool metrics configuration
    if (auto it = config.find("collect_pool_metrics"); it != config.end()) {
        collect_pool_metrics_ = (it->second == "true" || it->second == "1");
    }
 
    init_time_ = std::chrono::steady_clock::now();
    prev_collection_time_ = init_time_;
    initialized_ = true;
    return true;
}

References ae_title_, collect_pool_metrics_, init_time_, initialized_, and prev_collection_time_.

◆ is_healthy()

bool kcenon::pacs::monitoring::dicom_storage_collector::is_healthy ( ) const

inlinenodiscard

Check if the collector is healthy.

Returns: true if operational

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/collectors/dicom_storage_collector.h.

Definition at line 415 of file dicom_storage_collector.h.

                                                      {
    return initialized_;
}

References initialized_.

◆ is_pool_metrics_enabled()

bool kcenon::pacs::monitoring::dicom_storage_collector::is_pool_metrics_enabled ( ) const

inlinenodiscard

Check if pool metrics collection is enabled.

Returns: true if pool metrics are collected

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/collectors/dicom_storage_collector.h.

Definition at line 447 of file dicom_storage_collector.h.

                                                                   {
    return collect_pool_metrics_;
}

References collect_pool_metrics_.

◆ operator=() [1/2]

dicom_storage_collector & kcenon::pacs::monitoring::dicom_storage_collector::operator= ( const dicom_storage_collector & )

delete

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/collectors/dicom_storage_collector.h.

◆ operator=() [2/2]

dicom_storage_collector & kcenon::pacs::monitoring::dicom_storage_collector::operator= ( dicom_storage_collector && )

delete

◆ set_ae_title()

void kcenon::pacs::monitoring::dicom_storage_collector::set_ae_title ( std::string ae_title )

inline

Set the AE title for metric labels.

Parameters

ae_title The Application Entity title

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/collectors/dicom_storage_collector.h.

Definition at line 435 of file dicom_storage_collector.h.

                                                                    {
    ae_title_ = std::move(ae_title);
}

References ae_title_.

◆ set_pool_metrics_enabled()

void kcenon::pacs::monitoring::dicom_storage_collector::set_pool_metrics_enabled ( bool enabled )

inline

Enable or disable pool metrics collection.

Parameters

enabled Whether to collect pool metrics

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/collectors/dicom_storage_collector.h.

Definition at line 443 of file dicom_storage_collector.h.

                                                                          {
    collect_pool_metrics_ = enabled;
}

References collect_pool_metrics_.

Member Data Documentation

◆ ae_title_

std::string kcenon::pacs::monitoring::dicom_storage_collector::ae_title_

private

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/collectors/dicom_storage_collector.h.

Definition at line 176 of file dicom_storage_collector.h.

Referenced by create_metric(), get_ae_title(), initialize(), and set_ae_title().

◆ collect_pool_metrics_

bool kcenon::pacs::monitoring::dicom_storage_collector::collect_pool_metrics_ {true}

private

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/collectors/dicom_storage_collector.h.

Definition at line 178 of file dicom_storage_collector.h.

178{true};

Referenced by collect(), get_metric_types(), initialize(), is_pool_metrics_enabled(), and set_pool_metrics_enabled().

◆ collection_count_

std::uint64_t kcenon::pacs::monitoring::dicom_storage_collector::collection_count_ {0}

private

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/collectors/dicom_storage_collector.h.

Definition at line 182 of file dicom_storage_collector.h.

182{0};

Referenced by collect(), and get_statistics().

◆ init_time_

std::chrono::steady_clock::time_point kcenon::pacs::monitoring::dicom_storage_collector::init_time_

private

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/collectors/dicom_storage_collector.h.

Definition at line 183 of file dicom_storage_collector.h.

Referenced by get_statistics(), and initialize().

◆ initialized_

bool kcenon::pacs::monitoring::dicom_storage_collector::initialized_ {false}

private

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/collectors/dicom_storage_collector.h.

Definition at line 177 of file dicom_storage_collector.h.

177{false};

Referenced by collect(), get_statistics(), initialize(), and is_healthy().

◆ prev_bytes_received_

std::uint64_t kcenon::pacs::monitoring::dicom_storage_collector::prev_bytes_received_ {0}

private

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/collectors/dicom_storage_collector.h.

Definition at line 187 of file dicom_storage_collector.h.

187{0};

Referenced by collect_transfer_metrics().

◆ prev_bytes_sent_

std::uint64_t kcenon::pacs::monitoring::dicom_storage_collector::prev_bytes_sent_ {0}

private

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/collectors/dicom_storage_collector.h.

Definition at line 186 of file dicom_storage_collector.h.

186{0};

Referenced by collect_transfer_metrics().

◆ prev_collection_time_

std::chrono::steady_clock::time_point kcenon::pacs::monitoring::dicom_storage_collector::prev_collection_time_

private

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/collectors/dicom_storage_collector.h.

Definition at line 188 of file dicom_storage_collector.h.

Referenced by collect_transfer_metrics(), and initialize().

◆ stats_mutex_

std::mutex kcenon::pacs::monitoring::dicom_storage_collector::stats_mutex_

mutableprivate

Examples: /home/runner/work/pacs_system/pacs_system/include/kcenon/pacs/monitoring/collectors/dicom_storage_collector.h.

Definition at line 181 of file dicom_storage_collector.h.

Referenced by collect(), and get_statistics().

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

include/kcenon/pacs/monitoring/collectors/dicom_storage_collector.h

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ dicom_storage_collector() [1/3]

◆ ~dicom_storage_collector()

◆ dicom_storage_collector() [2/3]

◆ dicom_storage_collector() [3/3]

Member Function Documentation

◆ collect()

◆ collect_pool_metrics()

◆ collect_transfer_metrics()

◆ create_metric()

◆ get_ae_title()

◆ get_metric_types()

◆ get_name()

◆ get_statistics()

◆ initialize()

◆ is_healthy()

◆ is_pool_metrics_enabled()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ set_ae_title()

◆ set_pool_metrics_enabled()

Member Data Documentation

◆ ae_title_

◆ collect_pool_metrics_

◆ collection_count_

◆ init_time_

◆ initialized_

◆ prev_bytes_received_

◆ prev_bytes_sent_

◆ prev_collection_time_

◆ stats_mutex_