iceberg::ScanMetrics Class Reference

Live scan metrics collected during a table scan operation. More...

#include <scan_report.h>

Public Member Functions
ScanMetricsResult	ToResult () const
	Snapshot current counter/timer values into a ScanMetricsResult.

Static Public Member Functions
static std::unique_ptr< ScanMetrics >	Make (MetricsContext &context)
	Create a ScanMetrics instance backed by the given MetricsContext.
static std::unique_ptr< ScanMetrics >	Noop ()
	Create a ScanMetrics instance with all-noop counters and timer.

Public Attributes
std::shared_ptr< Timer >	total_planning_duration
std::shared_ptr< Counter >	result_data_files
std::shared_ptr< Counter >	result_delete_files
std::shared_ptr< Counter >	scanned_data_manifests
std::shared_ptr< Counter >	scanned_delete_manifests
std::shared_ptr< Counter >	total_data_manifests
std::shared_ptr< Counter >	total_delete_manifests
std::shared_ptr< Counter >	total_file_size_in_bytes
std::shared_ptr< Counter >	total_delete_file_size_in_bytes
std::shared_ptr< Counter >	skipped_data_manifests
std::shared_ptr< Counter >	skipped_delete_manifests
std::shared_ptr< Counter >	skipped_data_files
std::shared_ptr< Counter >	skipped_delete_files
std::shared_ptr< Counter >	indexed_delete_files
std::shared_ptr< Counter >	equality_delete_files
std::shared_ptr< Counter >	positional_delete_files
std::shared_ptr< Counter >	dvs

Detailed Description

Live scan metrics collected during a table scan operation.

Holds named Counter and Timer instances obtained from a MetricsContext. Call Make() at the start of a scan to obtain an instrumented instance, then increment counters and start/stop the planning timer as the scan proceeds. Call ToResult() at the end to obtain the serialisable ScanMetricsResult.

---

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

• iceberg/metrics/scan_report.h
• iceberg/metrics/scan_report.cc