kcenon::monitoring::storage_config Struct Reference

Storage configuration. More...

#include <storage_backends.h>

Collaboration diagram for kcenon::monitoring::storage_config:

Public Member Functions
common::Result< bool >	validate () const
	Validate configuration.

Public Attributes
storage_backend_type	type {storage_backend_type::memory_buffer}
std::string	path
std::string	data_directory
compression_algorithm	compression {compression_algorithm::none}
size_t	max_size_mb {100}
bool	auto_flush {true}
std::chrono::milliseconds	flush_interval {std::chrono::milliseconds(5000)}
size_t	max_capacity {1000}
size_t	batch_size {100}
std::string	table_name
std::string	host
uint16_t	port {0}
std::string	database_name
std::string	username
std::string	password

Detailed Description

Storage configuration.

Examples

basic_monitoring_example.cpp, production_monitoring_example.cpp, and storage_example.cpp.

Definition at line 56 of file storage_backends.h.

Member Function Documentation

validate()

common::Result< bool > kcenon::monitoring::storage_config::validate ( ) const

inline

Validate configuration.

Returns

common::Result<bool> indicating validation success or failure

Definition at line 79 of file storage_backends.h.

                                        {
        // Memory buffer doesn't require path
        if (type != storage_backend_type::memory_buffer) {
            if (path.empty() && host.empty()) {
                return common::Result<bool>::err(error_info(monitoring_error_code::invalid_configuration, "Path or host required for non-memory storage").to_common_error());
            }
        }
 
        if (max_capacity == 0) {
            return common::Result<bool>::err(error_info(monitoring_error_code::invalid_capacity, "Capacity must be greater than 0").to_common_error());
        }
 
        if (batch_size == 0) {
            return common::Result<bool>::err(error_info(monitoring_error_code::invalid_configuration, "Batch size must be greater than 0").to_common_error());
        }
 
        if (batch_size > max_capacity) {
            return common::Result<bool>::err(error_info(monitoring_error_code::invalid_configuration, "Batch size cannot exceed capacity").to_common_error());
        }
 
        return common::ok(true);
    }

References batch_size, host, kcenon::monitoring::invalid_capacity, kcenon::monitoring::invalid_configuration, max_capacity, kcenon::monitoring::memory_buffer, path, and type.

Referenced by TEST_F().

Here is the caller graph for this function:

Member Data Documentation

auto_flush

bool kcenon::monitoring::storage_config::auto_flush {true}

Definition at line 62 of file storage_backends.h.

{true};

batch_size

size_t kcenon::monitoring::storage_config::batch_size {100}

Definition at line 67 of file storage_backends.h.

{100};

Referenced by TEST_F(), and validate().

compression

compression_algorithm kcenon::monitoring::storage_config::compression {compression_algorithm::none}

Examples

storage_example.cpp.

Definition at line 60 of file storage_backends.h.

{compression_algorithm::none};

Referenced by main().

data_directory

std::string kcenon::monitoring::storage_config::data_directory

Examples

storage_example.cpp.

Definition at line 59 of file storage_backends.h.

Referenced by main().

database_name

std::string kcenon::monitoring::storage_config::database_name

Definition at line 71 of file storage_backends.h.

Referenced by TEST_F().

flush_interval

std::chrono::milliseconds kcenon::monitoring::storage_config::flush_interval {std::chrono::milliseconds(5000)}

Definition at line 63 of file storage_backends.h.

{std::chrono::milliseconds(5000)};

host

std::string kcenon::monitoring::storage_config::host

Definition at line 69 of file storage_backends.h.

Referenced by TEST_F(), and validate().

max_capacity

size_t kcenon::monitoring::storage_config::max_capacity {1000}

Definition at line 66 of file storage_backends.h.

{1000};

Referenced by kcenon::monitoring::cloud_storage_backend::capacity(), kcenon::monitoring::database_storage_backend::capacity(), kcenon::monitoring::file_storage_backend::capacity(), kcenon::monitoring::memory_storage_backend::capacity(), kcenon::monitoring::create_cloud_storage(), kcenon::monitoring::create_database_storage(), kcenon::monitoring::create_file_storage(), kcenon::monitoring::cloud_storage_backend::get_stats(), kcenon::monitoring::database_storage_backend::get_stats(), kcenon::monitoring::file_storage_backend::get_stats(), kcenon::monitoring::memory_storage_backend::get_stats(), kcenon::monitoring::cloud_storage_backend::store(), kcenon::monitoring::database_storage_backend::store(), kcenon::monitoring::file_storage_backend::store(), kcenon::monitoring::memory_storage_backend::store(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and validate().

max_size_mb

size_t kcenon::monitoring::storage_config::max_size_mb {100}

Definition at line 61 of file storage_backends.h.

{100};

password

std::string kcenon::monitoring::storage_config::password

Definition at line 73 of file storage_backends.h.

Referenced by TEST_F().

path

std::string kcenon::monitoring::storage_config::path

Examples

basic_monitoring_example.cpp, and production_monitoring_example.cpp.

Definition at line 58 of file storage_backends.h.

Referenced by kcenon::monitoring::create_cloud_storage(), kcenon::monitoring::create_database_storage(), kcenon::monitoring::create_file_storage(), main(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and validate().

port

uint16_t kcenon::monitoring::storage_config::port {0}

Definition at line 70 of file storage_backends.h.

{0};

Referenced by TEST_F().

table_name

std::string kcenon::monitoring::storage_config::table_name

Definition at line 68 of file storage_backends.h.

Referenced by kcenon::monitoring::create_database_storage(), and TEST_F().

type

storage_backend_type kcenon::monitoring::storage_config::type {storage_backend_type::memory_buffer}

Examples

basic_monitoring_example.cpp, and production_monitoring_example.cpp.

Definition at line 57 of file storage_backends.h.

{storage_backend_type::memory_buffer};

Referenced by kcenon::monitoring::storage_backend_factory::create_backend(), kcenon::monitoring::create_cloud_storage(), kcenon::monitoring::create_database_storage(), kcenon::monitoring::create_file_storage(), main(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and validate().

username

std::string kcenon::monitoring::storage_config::username

Definition at line 72 of file storage_backends.h.

Referenced by TEST_F().

---

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

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