duckdb::QueryMetrics Struct Reference

Collaboration diagram for duckdb::QueryMetrics:

Public Member Functions
void	UpdateMetric (const MetricType metric, idx_t addition)
idx_t	GetMetricValue (const MetricType metric) const
double	GetMetricInSeconds (const MetricType metric) const
void	Reset ()
void	Merge (const QueryMetrics &other)

Static Public Member Functions
static idx_t	GetMetricsIndex (MetricType type)

Public Attributes
ProfilingInfo	query_global_info
std::string	query_name
unique_ptr< ActiveTimer >	latency_timer

Private Attributes
atomic< idx_t >	active_metrics [ACTIVELY_TRACKED_METRICS]

Static Private Attributes
static constexpr const idx_t	ACTIVELY_TRACKED_METRICS = 11

Constructor & Destructor Documentation

QueryMetrics()

duckdb::QueryMetrics::QueryMetrics ( )

inline

                   {
        Reset();
    }

Member Function Documentation

UpdateMetric()

void duckdb::QueryMetrics::UpdateMetric ( const MetricType  metric, idx_t  addition  )

inline

                                                               {
        active_metrics[GetMetricsIndex(metric)] += addition;
    }

GetMetricValue()

idx_t duckdb::QueryMetrics::GetMetricValue ( const MetricType  metric ) const

inline

                                                        {
        return active_metrics[GetMetricsIndex(metric)];
    }

GetMetricInSeconds()

double duckdb::QueryMetrics::GetMetricInSeconds ( const MetricType  metric ) const

inline

                                                             {
        return static_cast<double>(active_metrics[GetMetricsIndex(metric)]) / 1e9;
    }

Reset()

void duckdb::QueryMetrics::Reset ( )

inline

                 {
        for(idx_t i = 0; i < ACTIVELY_TRACKED_METRICS; i++) {
            active_metrics[i] = 0;
        }
 
        latency_timer.reset();
        query_name = "";
    }

Merge()

void duckdb::QueryMetrics::Merge ( const QueryMetrics &  other )

inline

                                          {
        for(idx_t i = 0; i < ACTIVELY_TRACKED_METRICS; i++) {
            active_metrics[i] += other.active_metrics[i];
        }
    }

GetMetricsIndex()

static idx_t duckdb::QueryMetrics::GetMetricsIndex ( MetricType  type )

inlinestatic

                                                  {
        switch(type) {
        case MetricType::ATTACH_LOAD_STORAGE_LATENCY: return 0;
        case MetricType::ATTACH_REPLAY_WAL_LATENCY: return 1;
        case MetricType::CHECKPOINT_LATENCY: return 2;
        case MetricType::COMMIT_LOCAL_STORAGE_LATENCY: return 3;
        case MetricType::LATENCY: return 4;
        case MetricType::WAITING_TO_ATTACH_LATENCY: return 5;
        case MetricType::WRITE_TO_WAL_LATENCY: return 6;
        case MetricType::TOTAL_BYTES_READ: return 7;
        case MetricType::TOTAL_BYTES_WRITTEN: return 8;
        case MetricType::TOTAL_MEMORY_ALLOCATED: return 9;
        case MetricType::WAL_REPLAY_ENTRY_COUNT: return 10;
        default:
            throw InternalException("MetricType %s is not actively tracked.", EnumUtil::ToString(type));
        }
    }

---

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

• external/duckdb/duckdb.hpp