kcenon::monitoring::time_series_query Struct Reference

Query parameters for time series data. More...

#include <time_series.h>

Collaboration diagram for kcenon::monitoring::time_series_query:

Public Member Functions
	time_series_query ()
	time_series_query (std::chrono::system_clock::time_point start, std::chrono::system_clock::time_point end, std::chrono::milliseconds step_size=std::chrono::milliseconds(1000))
common::VoidResult	validate () const
	Validate query parameters.

Public Attributes
std::chrono::system_clock::time_point	start_time
std::chrono::system_clock::time_point	end_time
std::chrono::milliseconds	step {1000}

Detailed Description

Query parameters for time series data.

Examples

time_series_storage_example.cpp.

Definition at line 111 of file time_series.h.

Constructor & Destructor Documentation

time_series_query() [1/2]

kcenon::monitoring::time_series_query::time_series_query ( )

inline

Definition at line 116 of file time_series.h.

                        {
        auto now = std::chrono::system_clock::now();
        end_time = now;
        start_time = now - std::chrono::hours(1);  // Default: last hour
    }

References end_time, and start_time.

time_series_query() [2/2]

kcenon::monitoring::time_series_query::time_series_query ( std::chrono::system_clock::time_point start, std::chrono::system_clock::time_point end, std::chrono::milliseconds step_size = std::chrono::milliseconds(1000) )

inline

Definition at line 122 of file time_series.h.

        : start_time(start), end_time(end), step(step_size) {}

Member Function Documentation

validate()

common::VoidResult kcenon::monitoring::time_series_query::validate ( ) const

inline

Validate query parameters.

Definition at line 130 of file time_series.h.

                                      {
        if (start_time >= end_time) {
            error_info err(monitoring_error_code::invalid_argument,
                          "Start time must be before end time");
            return common::VoidResult::err(err.to_common_error());
        }
 
        if (step.count() <= 0) {
            error_info err(monitoring_error_code::invalid_argument,
                          "Step size must be positive");
            return common::VoidResult::err(err.to_common_error());
        }
 
        return common::ok();
    }

References end_time, kcenon::monitoring::invalid_argument, start_time, step, and kcenon::monitoring::error_info::to_common_error().

Here is the call graph for this function:

Member Data Documentation

end_time

std::chrono::system_clock::time_point kcenon::monitoring::time_series_query::end_time

Examples

time_series_storage_example.cpp.

Definition at line 113 of file time_series.h.

Referenced by demonstrate_aggregations(), demonstrate_basic_operations(), demonstrate_retention_and_downsampling(), TEST_F(), time_series_query(), and validate().

start_time

std::chrono::system_clock::time_point kcenon::monitoring::time_series_query::start_time

Examples

time_series_storage_example.cpp.

Definition at line 112 of file time_series.h.

Referenced by demonstrate_aggregations(), demonstrate_basic_operations(), demonstrate_retention_and_downsampling(), TEST_F(), time_series_query(), and validate().

step

std::chrono::milliseconds kcenon::monitoring::time_series_query::step {1000}

Examples

time_series_storage_example.cpp.

Definition at line 114 of file time_series.h.

{1000};  // Aggregation step size

Referenced by demonstrate_aggregations(), demonstrate_basic_operations(), demonstrate_retention_and_downsampling(), TEST_F(), and validate().

---

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

• include/kcenon/monitoring/utils/time_series.h