Collector for DICOM DIMSE service operation metrics. More...

#include <dicom_service_collector.h>

Collaboration diagram for kcenon::pacs::monitoring::dicom_service_collector:

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

	~dicom_service_collector ()=default
	Destructor.

	dicom_service_collector (const dicom_service_collector &)=delete

dicom_service_collector &	operator= (const dicom_service_collector &)=delete

	dicom_service_collector (dicom_service_collector &&)=delete

dicom_service_collector &	operator= (dicom_service_collector &&)=delete

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

std::vector< service_metric >	collect ()
	Collect current DIMSE service 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_operation_enabled (dimse_operation op, bool enabled)
	Enable or disable specific operation metrics.

bool	is_operation_enabled (dimse_operation op) const
	Check if metrics are enabled for an operation.

Private Member Functions
void	collect_operation_metrics (std::vector< service_metric > &metrics, dimse_operation op, const operation_counter &counter)

service_metric	create_metric (const std::string &name, double value, const std::string &type, const std::string &operation) const

Private Attributes
std::string	ae_title_

bool	initialized_ {false}

std::array< bool, 11 >	operation_enabled_

std::mutex	stats_mutex_

std::uint64_t	collection_count_ {0}

std::chrono::steady_clock::time_point	init_time_

Detailed Description

Collector for DICOM DIMSE service operation metrics.

This collector gathers metrics for all DIMSE operations including:

C-ECHO (Verification Service)
C-STORE (Storage Service)
C-FIND (Query Service)
C-MOVE (Retrieve Service)
C-GET (Retrieve Service)
N-CREATE, N-SET, N-GET, N-ACTION, N-EVENT, N-DELETE (Normalized Services)

For each operation, the collector reports:

Total request count
Success/failure counts
Duration statistics (average, min, max)
Throughput (requests/second)

Thread Safety: All public methods are thread-safe.

Definition at line 87 of file dicom_service_collector.h.

Constructor & Destructor Documentation

◆ dicom_service_collector() [1/3]

kcenon::pacs::monitoring::dicom_service_collector::dicom_service_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_service_collector.h.

Definition at line 215 of file dicom_service_collector.h.

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

kcenon::pacs::monitoring::dicom_service_collector::ae_title_

std::string ae_title_

Definition dicom_service_collector.h:184

◆ ~dicom_service_collector()

kcenon::pacs::monitoring::dicom_service_collector::~dicom_service_collector ( )

default

Destructor.

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

◆ dicom_service_collector() [2/3]

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

delete

◆ dicom_service_collector() [3/3]

kcenon::pacs::monitoring::dicom_service_collector::dicom_service_collector ( dicom_service_collector && )

delete

Member Function Documentation

◆ collect()

std::vector< service_metric > kcenon::pacs::monitoring::dicom_service_collector::collect ( )

inlinenodiscard

Collect current DIMSE service metrics.

Returns: Vector of service metrics

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

Definition at line 230 of file dicom_service_collector.h.

                                                                  {
    std::vector<service_metric> metrics;
 
    if (!initialized_) {
        return metrics;
    }
 
    const auto& pacs = pacs_metrics::global_metrics();
 
    // Collect metrics for each enabled DIMSE operation
    static constexpr std::array<dimse_operation, 11> all_ops = {
        dimse_operation::c_echo,
        dimse_operation::c_store,
        dimse_operation::c_find,
        dimse_operation::c_move,
        dimse_operation::c_get,
        dimse_operation::n_create,
        dimse_operation::n_set,
        dimse_operation::n_get,
        dimse_operation::n_action,
        dimse_operation::n_event,
        dimse_operation::n_delete
    };
 
    for (std::size_t i = 0; i < all_ops.size(); ++i) {
        if (operation_enabled_[i]) {
            collect_operation_metrics(
                metrics,
                all_ops[i],
                pacs.get_counter(all_ops[i]));
        }
    }
 
    // Update statistics
    {
        std::lock_guard<std::mutex> lock(stats_mutex_);
        ++collection_count_;
    }
 
    return metrics;
}

Here is the call graph for this function:

◆ collect_operation_metrics()

void kcenon::pacs::monitoring::dicom_service_collector::collect_operation_metrics	(	std::vector< service_metric > &	metrics,
		dimse_operation	op,
		const operation_counter &	counter )

inlineprivate

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

Definition at line 272 of file dicom_service_collector.h.

                                      {
 
    const std::string op_name(to_string(op));
 
    // Total requests (counter)
    metrics.push_back(create_metric(
        "dicom_" + op_name + "_requests_total",
        static_cast<double>(counter.total_count()),
        "counter",
        op_name));
 
    // Successful requests (counter)
    metrics.push_back(create_metric(
        "dicom_" + op_name + "_success_total",
        static_cast<double>(counter.success_count.load(std::memory_order_relaxed)),
        "counter",
        op_name));
 
    // Failed requests (counter)
    metrics.push_back(create_metric(
        "dicom_" + op_name + "_failure_total",
        static_cast<double>(counter.failure_count.load(std::memory_order_relaxed)),
        "counter",
        op_name));
 
    // Duration metrics (only if there have been requests)
    if (counter.total_count() > 0) {
        // Average duration in seconds (gauge)
        metrics.push_back(create_metric(
            "dicom_" + op_name + "_duration_seconds_avg",
            static_cast<double>(counter.average_duration_us()) / 1'000'000.0,
            "gauge",
            op_name));
 
        // Min duration in seconds (gauge)
        const auto min_us = counter.min_duration_us.load(std::memory_order_relaxed);
        if (min_us != UINT64_MAX) {
            metrics.push_back(create_metric(
                "dicom_" + op_name + "_duration_seconds_min",
                static_cast<double>(min_us) / 1'000'000.0,
                "gauge",
                op_name));
        }
 
        // Max duration in seconds (gauge)
        const auto max_us = counter.max_duration_us.load(std::memory_order_relaxed);
        if (max_us > 0) {
            metrics.push_back(create_metric(
                "dicom_" + op_name + "_duration_seconds_max",
                static_cast<double>(max_us) / 1'000'000.0,
                "gauge",
                op_name));
        }
 
        // Total duration in seconds (counter) - for calculating rates
        metrics.push_back(create_metric(
            "dicom_" + op_name + "_duration_seconds_sum",
            static_cast<double>(counter.total_duration_us.load(std::memory_order_relaxed)) / 1'000'000.0,
            "counter",
            op_name));
    }
}

References kcenon::pacs::monitoring::counter, create_metric(), and kcenon::pacs::monitoring::to_string().

Referenced by collect().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ create_metric()

service_metric kcenon::pacs::monitoring::dicom_service_collector::create_metric	(	const std::string &	name,
		double	value,
		const std::string &	type,
		const std::string &	operation ) const

inlinenodiscardprivate

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

Definition at line 411 of file dicom_service_collector.h.

                                      {
    return service_metric(
        name,
        value,
        type,
        {{"ae", ae_title_}, {"operation", operation}});
}

References ae_title_, and name.

Referenced by collect_operation_metrics().

Here is the caller graph for this function:

◆ get_ae_title()

std::string kcenon::pacs::monitoring::dicom_service_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_service_collector.h.

Definition at line 397 of file dicom_service_collector.h.

                                                             {
    return ae_title_;
}

References ae_title_.

◆ get_metric_types()

std::vector< std::string > kcenon::pacs::monitoring::dicom_service_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_service_collector.h.

Definition at line 342 of file dicom_service_collector.h.

                                                                            {
    std::vector<std::string> types;
 
    static constexpr std::array<dimse_operation, 11> all_ops = {
        dimse_operation::c_echo,
        dimse_operation::c_store,
        dimse_operation::c_find,
        dimse_operation::c_move,
        dimse_operation::c_get,
        dimse_operation::n_create,
        dimse_operation::n_set,
        dimse_operation::n_get,
        dimse_operation::n_action,
        dimse_operation::n_event,
        dimse_operation::n_delete
    };
 
    for (const auto op : all_ops) {
        const std::string op_name(to_string(op));
        types.push_back("dicom_" + op_name + "_requests_total");
        types.push_back("dicom_" + op_name + "_success_total");
        types.push_back("dicom_" + op_name + "_failure_total");
        types.push_back("dicom_" + op_name + "_duration_seconds_avg");
        types.push_back("dicom_" + op_name + "_duration_seconds_min");
        types.push_back("dicom_" + op_name + "_duration_seconds_max");
        types.push_back("dicom_" + op_name + "_duration_seconds_sum");
    }
 
    return types;
}

References kcenon::pacs::monitoring::c_echo, kcenon::pacs::monitoring::c_find, kcenon::pacs::monitoring::c_get, kcenon::pacs::monitoring::c_move, kcenon::pacs::monitoring::c_store, kcenon::pacs::monitoring::n_action, kcenon::pacs::monitoring::n_create, kcenon::pacs::monitoring::n_delete, kcenon::pacs::monitoring::n_event, kcenon::pacs::monitoring::n_get, kcenon::pacs::monitoring::n_set, and kcenon::pacs::monitoring::to_string().

Here is the call graph for this function:

◆ get_name()

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

inlinenodiscard

Get the collector name.

Returns: "dicom_service_collector"

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

Definition at line 338 of file dicom_service_collector.h.

                                                         {
    return "dicom_service_collector";
}

◆ get_statistics()

std::unordered_map< std::string, double > kcenon::pacs::monitoring::dicom_service_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_service_collector.h.

Definition at line 378 of file dicom_service_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_service_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_service_collector.h.

Definition at line 218 of file dicom_service_collector.h.

                                                          {
    // Extract AE title from config if provided
    if (auto it = config.find("ae_title"); it != config.end()) {
        ae_title_ = it->second;
    }
 
    init_time_ = std::chrono::steady_clock::now();
    initialized_ = true;
    return true;
}

References ae_title_, init_time_, and initialized_.

◆ is_healthy()

bool kcenon::pacs::monitoring::dicom_service_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_service_collector.h.

Definition at line 373 of file dicom_service_collector.h.

                                                      {
    return initialized_;
}

References initialized_.

◆ is_operation_enabled()

bool kcenon::pacs::monitoring::dicom_service_collector::is_operation_enabled ( dimse_operation op ) const

inlinenodiscard

Check if metrics are enabled for an operation.

Parameters

op	The DIMSE operation

Returns: true if enabled

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

Definition at line 407 of file dicom_service_collector.h.

                                                                                  {
    return operation_enabled_[static_cast<std::size_t>(op)];
}

References operation_enabled_.

◆ operator=() [1/2]

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

delete

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

◆ operator=() [2/2]

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

delete

◆ set_ae_title()

void kcenon::pacs::monitoring::dicom_service_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_service_collector.h.

Definition at line 393 of file dicom_service_collector.h.

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

References ae_title_.

◆ set_operation_enabled()

void kcenon::pacs::monitoring::dicom_service_collector::set_operation_enabled	(	dimse_operation	op,
		bool	enabled )

inline

Enable or disable specific operation metrics.

Parameters

op	The DIMSE operation
enabled	Whether to collect metrics for this operation

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

Definition at line 401 of file dicom_service_collector.h.

                  {
    operation_enabled_[static_cast<std::size_t>(op)] = enabled;
}

References operation_enabled_.

Member Data Documentation

◆ ae_title_

std::string kcenon::pacs::monitoring::dicom_service_collector::ae_title_

private

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

Definition at line 184 of file dicom_service_collector.h.

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

◆ collection_count_

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

private

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

Definition at line 195 of file dicom_service_collector.h.

195{0};

Referenced by collect(), and get_statistics().

◆ init_time_

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

private

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

Definition at line 196 of file dicom_service_collector.h.

Referenced by get_statistics(), and initialize().

◆ initialized_

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

private

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

Definition at line 185 of file dicom_service_collector.h.

185{false};

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

◆ operation_enabled_

std::array<bool, 11> kcenon::pacs::monitoring::dicom_service_collector::operation_enabled_

private

Initial value:

{
        true, true, true, true, true,  
        true, true, true, true, true, true  
    }

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

Definition at line 188 of file dicom_service_collector.h.

                                         {
        true, true, true, true, true,  // C-ECHO, C-STORE, C-FIND, C-MOVE, C-GET
        true, true, true, true, true, true  // N-CREATE, N-SET, N-GET, N-ACTION, N-EVENT, N-DELETE
    };

Referenced by collect(), is_operation_enabled(), and set_operation_enabled().

◆ stats_mutex_

std::mutex kcenon::pacs::monitoring::dicom_service_collector::stats_mutex_

mutableprivate

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

Definition at line 194 of file dicom_service_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_service_collector.h

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ dicom_service_collector() [1/3]

◆ ~dicom_service_collector()

◆ dicom_service_collector() [2/3]

◆ dicom_service_collector() [3/3]

Member Function Documentation

◆ collect()

◆ collect_operation_metrics()

◆ create_metric()

◆ get_ae_title()

◆ get_metric_types()

◆ get_name()

◆ get_statistics()

◆ initialize()

◆ is_healthy()

◆ is_operation_enabled()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ set_ae_title()

◆ set_operation_enabled()

Member Data Documentation

◆ ae_title_

◆ collection_count_

◆ init_time_

◆ initialized_

◆ operation_enabled_

◆ stats_mutex_