kcenon::monitoring::memory_storage_backend Class Reference

In-memory snapshot storage backend. More...

#include <storage_backends.h>

Inheritance diagram for kcenon::monitoring::memory_storage_backend:

Collaboration diagram for kcenon::monitoring::memory_storage_backend:

Public Member Functions
	memory_storage_backend ()
	memory_storage_backend (const storage_config &config)
common::Result< bool >	store (const metrics_snapshot &snapshot) override
common::Result< metrics_snapshot >	retrieve (size_t index) override
common::Result< std::vector< metrics_snapshot > >	retrieve_range (size_t start, size_t count) override
size_t	size () const override
size_t	capacity () const override
common::Result< bool >	flush () override
common::Result< bool >	clear () override
std::unordered_map< std::string, size_t >	get_stats () const override
Public Member Functions inherited from kcenon::monitoring::snapshot_storage_backend
virtual	~snapshot_storage_backend ()=default

Private Attributes
storage_config	config_
std::deque< metrics_snapshot >	snapshots_
std::mutex	mutex_

Detailed Description

In-memory snapshot storage backend.

Definition at line 358 of file storage_backends.h.

Constructor & Destructor Documentation

memory_storage_backend() [1/2]

kcenon::monitoring::memory_storage_backend::memory_storage_backend ( )

inline

Definition at line 360 of file storage_backends.h.

: config_() {}

memory_storage_backend() [2/2]

kcenon::monitoring::memory_storage_backend::memory_storage_backend ( const storage_config & config )

inlineexplicit

Definition at line 362 of file storage_backends.h.

        : config_(config) {}

Member Function Documentation

capacity()

size_t kcenon::monitoring::memory_storage_backend::capacity ( ) const

inlineoverridevirtual

Implements kcenon::monitoring::snapshot_storage_backend.

Definition at line 404 of file storage_backends.h.

                                     {
        return config_.max_capacity;
    }

References config_, and kcenon::monitoring::storage_config::max_capacity.

clear()

common::Result< bool > kcenon::monitoring::memory_storage_backend::clear ( )

inlineoverridevirtual

Implements kcenon::monitoring::snapshot_storage_backend.

Definition at line 412 of file storage_backends.h.

                                        {
        std::lock_guard<std::mutex> lock(mutex_);
        snapshots_.clear();
        return common::ok(true);
    }

References mutex_, and snapshots_.

flush()

common::Result< bool > kcenon::monitoring::memory_storage_backend::flush ( )

inlineoverridevirtual

Implements kcenon::monitoring::snapshot_storage_backend.

Definition at line 408 of file storage_backends.h.

                                        {
        return common::ok(true);
    }

get_stats()

std::unordered_map< std::string, size_t > kcenon::monitoring::memory_storage_backend::get_stats ( ) const

inlineoverridevirtual

Implements kcenon::monitoring::snapshot_storage_backend.

Definition at line 418 of file storage_backends.h.

                                                                   {
        std::lock_guard<std::mutex> lock(mutex_);
        return {
            {"stored_count", snapshots_.size()},
            {"capacity", config_.max_capacity}
        };
    }

References config_, kcenon::monitoring::storage_config::max_capacity, mutex_, and snapshots_.

retrieve()

common::Result< metrics_snapshot > kcenon::monitoring::memory_storage_backend::retrieve ( size_t index )

inlineoverridevirtual

Implements kcenon::monitoring::snapshot_storage_backend.

Definition at line 376 of file storage_backends.h.

                                                                   {
        std::lock_guard<std::mutex> lock(mutex_);
 
        if (index >= snapshots_.size()) {
            return common::Result<metrics_snapshot>::err(error_info(monitoring_error_code::not_found, "Snapshot index out of range").to_common_error());
        }
 
        return common::ok(snapshots_[index]);
    }

References mutex_, kcenon::monitoring::not_found, and snapshots_.

retrieve_range()

common::Result< std::vector< metrics_snapshot > > kcenon::monitoring::memory_storage_backend::retrieve_range ( size_t start, size_t count )

inlineoverridevirtual

Implements kcenon::monitoring::snapshot_storage_backend.

Definition at line 386 of file storage_backends.h.

                                                                                                  {
        std::lock_guard<std::mutex> lock(mutex_);
 
        std::vector<metrics_snapshot> result;
        size_t end = std::min(start + count, snapshots_.size());
 
        for (size_t i = start; i < end; ++i) {
            result.push_back(snapshots_[i]);
        }
 
        return common::ok(std::move(result));
    }

References mutex_, and snapshots_.

size()

size_t kcenon::monitoring::memory_storage_backend::size ( ) const

inlineoverridevirtual

Implements kcenon::monitoring::snapshot_storage_backend.

Definition at line 399 of file storage_backends.h.

                                 {
        std::lock_guard<std::mutex> lock(mutex_);
        return snapshots_.size();
    }

References mutex_, and snapshots_.

store()

common::Result< bool > kcenon::monitoring::memory_storage_backend::store ( const metrics_snapshot & snapshot )

inlineoverridevirtual

Implements kcenon::monitoring::snapshot_storage_backend.

Definition at line 365 of file storage_backends.h.

                                                                        {
        std::lock_guard<std::mutex> lock(mutex_);
 
        if (snapshots_.size() >= config_.max_capacity) {
            snapshots_.pop_front();
        }
 
        snapshots_.push_back(snapshot);
        return common::ok(true);
    }

References config_, kcenon::monitoring::storage_config::max_capacity, mutex_, and snapshots_.

Member Data Documentation

config_

storage_config kcenon::monitoring::memory_storage_backend::config_

private

Definition at line 427 of file storage_backends.h.

Referenced by capacity(), get_stats(), and store().

mutex_

std::mutex kcenon::monitoring::memory_storage_backend::mutex_

mutableprivate

Definition at line 429 of file storage_backends.h.

Referenced by clear(), get_stats(), retrieve(), retrieve_range(), size(), and store().

snapshots_

std::deque<metrics_snapshot> kcenon::monitoring::memory_storage_backend::snapshots_

private

Definition at line 428 of file storage_backends.h.

Referenced by clear(), get_stats(), retrieve(), retrieve_range(), size(), and store().

---

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

• include/kcenon/monitoring/storage/storage_backends.h