Struct QueryMetrics 

pub struct QueryMetrics {

    pub query_id: QueryId,
    pub trace_id: Option<TraceId>,
    pub boundary: BoundaryMetrics,
    pub operators: Vec<OperatorMetrics>,
    pub graph_algorithm_runtime_rows: Vec<GraphAlgorithmRuntimeMetrics>,
    pub graph_claim_calibration_rows: Vec<GraphMeasuredPeakRow>,
    pub join_strategy_decisions: Vec<JoinStrategyDecisionMetrics>,
    pub aggregate_strategy_decisions: Vec<AggregateStrategyDecisionMetrics>,
    pub dynamic_filter_runtime_rows: Vec<DynamicFilterRuntimeMetrics>,
    pub source_read_runtime_rows: Vec<SourceReadRuntimeMetrics>,
    pub lakehouse_cache_fill_events: Vec<LakehouseCacheFillEventSnapshot>,
    pub input_batches: u64,
    pub input_rows: u64,
    pub peak_device_memory_bytes: Option<u64>,
    pub resident_dataframe_peak_bytes: Option<u64>,
    pub allocator_high_water_bytes: Option<u64>,
    pub max_task_observed_peak_bytes: Option<u64>,
    pub max_task_retained_bytes: Option<u64>,
    pub task_operator_metrics: BTreeMap<String, TaskOperatorMetrics>,
    pub task_runtime_metrics: BTreeMap<String, TaskRuntimeMetrics>,
    pub plan_task_mapping_rows: Vec<PlanTaskMapping>,
    pub plan_task_mapping_datafusion_shape: Option<String>,
    pub budgeted_execution_events: Vec<BudgetedExecutionEvent>,
    pub source_chunks_planned: u64,
    pub source_chunks_attempted: u64,
    pub source_chunks_committed: u64,
    pub source_chunks_retried: u64,
    pub source_read_prefetches_started: u64,
    pub source_read_prefetches_completed: u64,
    pub source_read_prefetches_skipped: u64,
    pub source_read_prefetches_abandoned: u64,
    pub row_groups_planned: u64,
    pub row_groups_committed: u64,
    pub partial_aggregate_count: u64,
    pub partial_aggregate_input_rows: u64,
    pub partial_aggregate_rows: u64,
    pub partial_aggregate_retained_bytes: u64,
    pub final_merge_attempts: u64,
    pub final_merge_levels: u64,
    pub final_merge_max_fan_in: u64,
    pub retry_count: u64,
    pub retry_resource_exhausted_count: u64,
    pub hash_join_build_count: u64,
    pub filtered_join_build_count: u64,
    pub one_shot_join_count: u64,
    pub hash_join_hash_table_bytes: u64,
    pub filtered_join_hash_table_bytes: u64,
    pub filtered_join_probe_state_bytes: u64,
    pub mixed_join_size_data_bytes: u64,
    pub one_shot_join_index_bytes: u64,
    pub one_shot_join_materialization_bytes: u64,
    pub one_shot_join_output_bytes: u64,
    pub parquet_files: u64,
    pub parquet_bytes_known: u64,
    pub row_groups_selected: u64,
    pub read_columns: u64,
    pub source_metadata_load_time: Duration,
    pub source_read_queue_wait_time: Duration,
    pub parquet_read_time: Duration,
    pub source_read_time: Duration,
    pub operator_time: Duration,
    pub chunk_operator_time: Duration,
    pub final_merge_time: Duration,
    pub final_sort_time: Duration,
    pub materialization_time: Duration,
    pub compiled_pipeline_attempts: u64,
    pub compiled_pipeline_tasks_executed: u64,
    pub compiled_pipeline_host_arrow_sinks: u64,
    pub dynamic_filter_produced_count: u64,
    pub dynamic_filter_skipped_count: u64,
    pub dynamic_filter_applied_count: u64,
    pub dynamic_filter_row_groups_pruned: u64,
    pub dynamic_filter_source_bytes_pruned: u64,
    pub dynamic_filter_reader_predicate_rows_before: u64,
    pub dynamic_filter_reader_predicate_rows_after: u64,
    pub dynamic_filter_reader_predicate_rows_filtered: u64,
    pub dynamic_filter_post_decode_rows_before: u64,
    pub dynamic_filter_post_decode_rows_after: u64,
    pub dynamic_filter_post_decode_rows_filtered: u64,
    pub dynamic_filter_source_post_decode_rows_filtered: u64,
    pub dynamic_filter_filter_post_decode_rows_filtered: u64,
    pub dynamic_filter_join_probe_post_decode_rows_filtered: u64,
    pub projection: Option<MetricsProjection>,
    pub join_gather_map_bytes: u64,
    /* private fields */
}

Query-scoped metrics accumulated during native execution.

Fields

query_id: QueryId

Query-wide diagnostic correlation id.

trace_id: Option<TraceId>

Optional parent trace id.

boundary: BoundaryMetrics

Data-boundary transfer counters.

operators: Vec<OperatorMetrics>

Operator-level metric rows in observation order.

graph_algorithm_runtime_rows: Vec<GraphAlgorithmRuntimeMetrics>

Graph algorithm runtime rows in observation order.

graph_claim_calibration_rows: Vec<GraphMeasuredPeakRow>

Fixed-shape measured graph-execution peak rows in observation order. These are diagnostic projections and never form admission evidence.

join_strategy_decisions: Vec<JoinStrategyDecisionMetrics>

Join-strategy diagnostics captured during planning/execution.

aggregate_strategy_decisions: Vec<AggregateStrategyDecisionMetrics>

Aggregate-strategy diagnostics captured during planning/execution.

dynamic_filter_runtime_rows: Vec<DynamicFilterRuntimeMetrics>

Dynamic-filter runtime event rows in observation order.

source_read_runtime_rows: Vec<SourceReadRuntimeMetrics>

Source-read runtime event rows in observation order.

lakehouse_cache_fill_events: Vec<LakehouseCacheFillEventSnapshot>

Background lakehouse cache-fill completions this plan execution carries: those its owner retained since the previous plan froze.

input_batches: u64

Number of input batches observed by native execution.

input_rows: u64

Number of input rows observed by native execution.

peak_device_memory_bytes: Option<u64>

Backward-compatible alias for resident_dataframe_peak_bytes.

This is not an allocator high-water mark.

resident_dataframe_peak_bytes: Option<u64>

Peak bytes retained by resident cudf DataFrames.

allocator_high_water_bytes: Option<u64>

Allocation high-water bytes of the attempt’s allocation domain when the plan execution ended. Absent without an admitted attempt.

max_task_observed_peak_bytes: Option<u64>

Largest lower-level budgeted cuDF peak reported by a task-like operation.

max_task_retained_bytes: Option<u64>

Largest retained byte count reported by a task-like lower-level cuDF operation.

task_operator_metrics: BTreeMap<String, TaskOperatorMetrics>

Metrics aggregated by task operator kind.

task_runtime_metrics: BTreeMap<String, TaskRuntimeMetrics>

Metrics keyed by compiled pipeline task id.

plan_task_mapping_rows: Vec<PlanTaskMapping>

Query-local mapping rows between native plan nodes and compiled tasks.

plan_task_mapping_datafusion_shape: Option<String>

Optional frontend physical-plan shape used to annotate plan/task mapping rows.

budgeted_execution_events: Vec<BudgetedExecutionEvent>

Successful lower-level cuDF calls that returned an execution-budget report.

Token-routed operations without a report-returning cuDF API may still attach budget failure facts on errors, but they do not synthesize success events here.

source_chunks_planned: u64

Source chunks produced by native source planning.

source_chunks_attempted: u64

Includes both first attempts and retries.

source_chunks_committed: u64

Source chunks whose native read committed successfully.

source_chunks_retried: u64

Additional source chunk attempts after recoverable resource failures.

source_read_prefetches_started: u64

Source prefetch jobs submitted to workers.

source_read_prefetches_completed: u64

Source prefetch jobs that returned completed read results.

source_read_prefetches_skipped: u64

Source prefetch opportunities skipped before a job was started.

source_read_prefetches_abandoned: u64

Started source prefetches abandoned before their result was consumed.

row_groups_planned: u64

Row groups planned across source chunks.

row_groups_committed: u64

Row groups committed across source chunks.

partial_aggregate_count: u64

Number of partial aggregate tasks.

partial_aggregate_input_rows: u64

Input rows consumed by partial aggregates.

partial_aggregate_rows: u64

Rows produced by partial aggregates.

partial_aggregate_retained_bytes: u64

Peak retained bytes from partial aggregate outputs.

final_merge_attempts: u64

Native final aggregate merge attempts, including bounded retries.

final_merge_levels: u64

Aggregate merge levels executed over retained partial results.

final_merge_max_fan_in: u64

Largest fan-in observed across final-merge levels.

retry_count: u64

Bounded native execution retries recorded by their owning operators.

retry_resource_exhausted_count: u64

Retries caused by lower-level resource exhaustion.

hash_join_build_count: u64

Number of reusable cuDF hash-join artifacts built during this query.

filtered_join_build_count: u64

Number of reusable cuDF filtered-join artifacts built during this query.

one_shot_join_count: u64

Number of one-shot keyed equality joins executed during this query.

hash_join_hash_table_bytes: u64

Unique device bytes retained by reusable cuDF hash-join build artifacts.

The value is recorded when an artifact is constructed. Reusing an artifact does not record it again.

filtered_join_hash_table_bytes: u64

Unique device bytes retained by reusable cuDF filtered-join build artifacts.

The value is recorded when an artifact is constructed. Reusing an artifact does not record it again.

filtered_join_probe_state_bytes: u64

Unique device bytes retained by filtered-join probe states.

mixed_join_size_data_bytes: u64

Unique device bytes retained by mixed inner/left join size-data states.

one_shot_join_index_bytes: u64

Device bytes retained by one-shot join index maps while materializing output.

one_shot_join_materialization_bytes: u64

Reservation bytes requested for one-shot join output materialization.

one_shot_join_output_bytes: u64

Observed device bytes of one-shot join output frames.

parquet_files: u64

Number of Parquet files observed by source reads.

parquet_bytes_known: u64

Sum of known Parquet file bytes.

row_groups_selected: u64

Row groups selected by source reads.

read_columns: u64

Physical read columns selected by source reads.

source_metadata_load_time: Duration

Time spent loading source metadata.

source_read_queue_wait_time: Duration

Time spent waiting in the source-read queue.

parquet_read_time: Duration

Time spent inside Parquet read calls.

source_read_time: Duration

Time spent in source-read orchestration.

operator_time: Duration

Time spent in non-source operators.

chunk_operator_time: Duration

Time spent in per-chunk operators.

final_merge_time: Duration

Time spent in final merge operators.

final_sort_time: Duration

Time spent in final sort operators.

materialization_time: Duration

Time spent materializing final outputs.

compiled_pipeline_attempts: u64

Bounded queries whose capability-admitted graph was accepted by the compiled-pipeline executor before execution started.

compiled_pipeline_tasks_executed: u64

Compiled-pipeline tasks completed by the scheduler.

compiled_pipeline_host_arrow_sinks: u64

Host Arrow sink boundaries materialized by the compiled-pipeline executor.

dynamic_filter_produced_count: u64

Dynamic-filter payloads successfully produced.

dynamic_filter_skipped_count: u64

Dynamic-filter routes whose producers completed without a usable payload.

dynamic_filter_applied_count: u64

Dynamic-filter payloads applied to a runtime consumer.

dynamic_filter_row_groups_pruned: u64

Row groups removed from source reads by dynamic filters.

dynamic_filter_source_bytes_pruned: u64

Estimated source-read bytes removed by dynamic filters.

dynamic_filter_reader_predicate_rows_before: u64

Source rows selected before dynamic reader predicates were applied.

Counted once per source chunk even when several dynamic-filter routes merge into one reader predicate; query-level totals do not double count.

dynamic_filter_reader_predicate_rows_after: u64

Source rows materialized after dynamic reader predicates were applied.

Counted once per source chunk, matching Self::dynamic_filter_reader_predicate_rows_before.

dynamic_filter_reader_predicate_rows_filtered: u64

Source rows removed by dynamic reader predicates.

Counted once per source chunk and only when both before/after row counts are known.

dynamic_filter_post_decode_rows_before: u64

Materialized rows before post-decode dynamic filters were applied.

Counted once per post-decode filter application or stream chunk.

dynamic_filter_post_decode_rows_after: u64

Materialized rows after post-decode dynamic filters were applied.

Counted once per post-decode filter application or stream chunk.

dynamic_filter_post_decode_rows_filtered: u64

Materialized rows removed by post-decode dynamic filters.

Counted once per post-decode filter application or stream chunk and only when both before/after row counts are known.

dynamic_filter_source_post_decode_rows_filtered: u64

Materialized rows removed by source-adjacent post-decode dynamic filters.

dynamic_filter_filter_post_decode_rows_filtered: u64

Materialized rows removed by filter-operator post-decode dynamic filters.

dynamic_filter_join_probe_post_decode_rows_filtered: u64

Materialized rows removed by hash-join-probe post-decode dynamic filters.

projection: Option<MetricsProjection>

Where this value’s owner-projected metrics came from and what they can claim. None means no observation owner has projected into it.

join_gather_map_bytes: u64

Join gather-map bytes across every recorded operator. Kept as a total because operator rows are retained under a bound and may be incomplete.

Implementations

impl QueryMetrics

pub fn record_aggregate_strategy_decision( &mut self, node_id: impl ToString, facts: &BTreeMap<&'static str, String>, )

Records aggregate-strategy diagnostics for a node or execution stage.

pub fn record_partial_aggregate( &mut self, input_rows: u64, output_rows: u64, retained_bytes: u64, )

Records one partial aggregate task summary.

pub fn record_final_merge_attempt(&mut self, merge_fan_in: usize)

Records one final merge attempt and fan-in.

pub fn record_final_merge_level(&mut self)

Records one final merge level.

impl QueryMetrics

pub fn descriptors() -> &'static [MetricDescriptor]

Returns the query-metric descriptor catalog.

impl QueryMetrics

pub fn record_dynamic_filter_produced( &mut self, route: &DynamicFilterRoute, filter: &DynamicFilter, producer_rows: u64, )

Records a dynamic-filter payload produced at runtime.

pub fn record_dynamic_filter_skipped( &mut self, route: &DynamicFilterRoute, reason: impl Into<String>, )

Records a dynamic-filter producer that completed without a usable payload.

pub fn record_dynamic_filter_applied( &mut self, route: &DynamicFilterRoute, filter: &DynamicFilter, before: DynamicFilterSourceSnapshot, after: DynamicFilterSourceSnapshot, )

Records a dynamic-filter payload applied to a local-Parquet source consumer.

pub fn record_dynamic_filter_applied_post_decode( &mut self, route: &DynamicFilterRoute, filter: &DynamicFilter, rows_before: Option<u64>, rows_after: Option<u64>, )

Records a dynamic-filter payload applied to a non-source consumer.

pub fn record_dynamic_filter_source_post_decode_stage( &mut self, route: &DynamicFilterRoute, filter: &DynamicFilter, rows_before: Option<u64>, rows_after: Option<u64>, )

Records an additional post-decode source stage for a route that was already counted as applied to its source consumer.

pub fn record_dynamic_filter_post_decode_rows( &mut self, route: &DynamicFilterRoute, filter: &DynamicFilter, rows_before: Option<u64>, rows_after: Option<u64>, )

Records post-decode row evidence for a route already counted as applied.

Lazy stream consumers install a route once, but the row reduction is only known as chunks are consumed.

pub fn record_dynamic_filter_source_reader_predicate_rows( &mut self, route: &DynamicFilterRoute, filter: &DynamicFilter, source_file_index: usize, source_chunk_index: usize, rows_before: Option<u64>, rows_after: Option<u64>, )

Records source-reader row evidence for a dynamic-filter reader predicate.

pub fn record_dynamic_filter_source_reader_predicate_batch_rows( &mut self, route: &DynamicFilterRoute, filter: &DynamicFilter, rows_before: Option<u64>, rows_after: Option<u64>, )

Records source-reader row evidence for a batched dynamic-filter reader predicate.

pub fn record_dynamic_filter_reader_predicate_source_reduction( &mut self, rows_before: Option<u64>, rows_after: Option<u64>, )

Records de-duplicated source-reader row reduction for a chunk.

impl QueryMetrics

pub fn record_graph_algorithm_runtime( &mut self, metrics: GraphAlgorithmRuntimeMetrics, )

Appends one graph algorithm runtime row.

pub fn record_graph_claim_calibration( &mut self, node_id: NodeId, algorithm: GraphAlgorithm, )

Opens a pending measured-peak observation row for one graph executor invocation.

The caller supplies the plan NodeId that owns this graph node. The completion sample then correlates by typed node identity without parsing the rendered node_id string.

pub fn record_graph_claim_calibration_measurement( &mut self, node_id: NodeId, algorithm: GraphAlgorithm, measured_peak_bytes: Option<u64>, measured_peak_provenance: GraphMeasuredPeakProvenance, )

Completes the most recent pending measured-peak row for the exact graph node/algorithm invocation.

The node index and enum are carried directly from the executor. No peak provenance is inferred from a rendered error, a label, or a missing numeric value.

pub fn record_graph_claim_calibration_algorithm_started( &mut self, node_id: NodeId, algorithm: GraphAlgorithm, )

Records the exact transition into the native graph algorithm executor. A claim that remains pending never becomes physical by implication.

pub fn graph_claim_calibration_rows(&self) -> &[GraphMeasuredPeakRow]

Returns the fixed-shape graph measured-peak rows collected for this execution. The returned projection is read-only and cannot alter admission state or memory accounting.

impl QueryMetrics

pub fn record_join_strategy_decision( &mut self, node_id: impl ToString, facts: &BTreeMap<&'static str, String>, )

Records join-strategy diagnostics for a node.

pub fn record_hash_join_build(&mut self)

Records one reusable hash-join build.

pub fn record_filtered_join_build(&mut self)

Records one reusable filtered-join build.

pub fn record_one_shot_join(&mut self)

Records a one-shot join execution.

pub fn record_hash_join_hash_table_bytes(&mut self, bytes: u64)

Adds retained hash-join hash table bytes.

pub fn record_filtered_join_hash_table_bytes(&mut self, bytes: u64)

Adds retained filtered-join hash table bytes.

pub fn record_filtered_join_probe_state_bytes(&mut self, bytes: u64)

Adds retained filtered-join probe-state bytes.

pub fn record_mixed_join_size_data_bytes(&mut self, bytes: u64)

Adds retained mixed-join size-data bytes.

pub fn record_one_shot_join_index_bytes(&mut self, bytes: u64)

Adds one-shot join index-map bytes.

pub fn record_one_shot_join_materialization_bytes(&mut self, bytes: u64)

Adds one-shot join output materialization reservation bytes.

pub fn record_one_shot_join_output_bytes(&mut self, bytes: u64)

Adds one-shot join output bytes.

impl QueryMetrics

pub fn to_json(&self) -> Value

Serializes query metrics as a nested, self-describing JSON document.

The metrics object is generated by walking Self::descriptors, so scalar JSON field names and descriptor names share one catalog.

impl QueryMetrics

pub fn record_device_memory_observation(&mut self, bytes: u64)

Records a resident DataFrame memory observation in bytes.

pub fn record_allocator_high_water_bytes(&mut self, bytes: u64)

Records the allocation high-water mark of the attempt’s allocation domain in bytes. The mark covers every plan of the attempt, not only the plan these metrics belong to.

impl QueryMetrics

pub fn record_operator_metrics(&mut self, metrics: OperatorMetrics)

Appends one operator metric row.

impl QueryMetrics

pub fn apply_owner_checkpoint(&mut self, checkpoint: &QueryMetricsCheckpoint)

Projects a plan execution’s metrics from its owner checkpoint.

Every fact-driven field is replaced by the checkpoint’s absolute value, so applying the same checkpoint twice leaves the value unchanged. Only the identity fields this value was created with are kept; the observation owner is the only writer of everything else.

pub fn record_source_read_runtime(&mut self, metrics: SourceReadRuntimeMetrics)

Records one local-Parquet source read or source-batch read.

pub fn record_input_batch(&mut self, rows: u64)

Records one input batch and its row count.

pub fn record_parquet_source( &mut self, known_bytes: Option<u64>, selected_row_groups: u64, read_columns: u64, )

Records one Parquet source file observation.

pub fn record_source_chunk_planned(&mut self, row_groups: u64)

Records that a source chunk was planned.

pub fn record_source_chunk_attempt(&mut self)

Records one source chunk attempt.

pub fn record_source_chunk_commit(&mut self, row_groups: u64)

Records one committed source chunk and row-group count.

pub fn record_source_chunk_commit_count( &mut self, chunk_count: u64, row_groups: u64, )

Records committed source chunks and row-group count.

pub fn record_source_chunk_retry(&mut self)

Records one source chunk retry.

pub fn record_source_read_prefetch_started(&mut self)

Records a started source-read prefetch.

pub fn record_source_read_prefetch_completed(&mut self)

Records a completed source-read prefetch.

pub fn record_source_read_prefetch_skipped(&mut self)

Records a skipped source-read prefetch.

pub fn record_source_read_prefetch_abandoned(&mut self)

Records an abandoned source-read prefetch.

impl QueryMetrics

pub fn record_budgeted_execution( &mut self, operation: impl Into<String>, report: &ExecutionBudgetReport, )

Records a lower-level cuDF execution-budget report.

pub fn record_compiled_pipeline_task_execution( &mut self, compiled_task_id: impl ToString, operator_kind: impl Into<String>, )

Records execution of a compiled pipeline task.

pub fn record_compiled_pipeline_task_mapping( &mut self, compiled_task_id: impl ToString, operator_kind: impl Into<String>, plan_node_id: Option<impl Into<PlanNodeId>>, )

Records a diagnostic mapping between a compiled task and its source plan node.

pub fn record_task_elapsed( &mut self, task_id: impl ToString, operator_kind: impl Into<String>, elapsed: Duration, )

Adds elapsed time to a task and its operator-kind aggregate.

pub fn plan_task_mappings(&self) -> Vec<PlanTaskMapping>

Builds the query-local mapping surface between plan node ids and compiled task ids.

pub fn record_retry_resource_exhausted(&mut self)

Records one retry caused by resource exhaustion.

pub fn record_compiled_pipeline_attempt(&mut self)

Records one compiled-pipeline execution attempt.

pub fn record_compiled_pipeline_tasks_executed(&mut self, tasks: u64)

Adds completed compiled-pipeline task count.

pub fn record_compiled_pipeline_host_arrow_sink(&mut self)

Records one compiled-pipeline Host Arrow sink.

impl QueryMetrics

pub fn new(query_id: impl Into<QueryId>) -> Self

Creates empty metrics for a query id minted or supplied by the caller.

pub fn query_id(&self) -> &QueryId

Returns the query-wide diagnostic correlation id.

pub fn set_query_id(&mut self, query_id: impl Into<QueryId>)

Assigns a query id to this metrics value and any already-collected runtime rows.

pub fn with_query_id(self, query_id: impl Into<QueryId>) -> Self

Consumes this metrics value, assigns the query id as set_query_id does, and returns it.

pub fn with_plan_task_mapping_datafusion_shape( self, shape: impl Into<String>, ) -> Self

Sets the frontend shape on this value and on each plan/task mapping row that has none. An empty shape is ignored.

pub fn merge_from(&mut self, other: QueryMetrics)

Merges another query metrics value into this one.

Trait Implementations

impl Clone for QueryMetrics

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for QueryMetrics

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for QueryMetrics

fn default() -> Self

Returns the “default value” for a type.

impl Eq for QueryMetrics

impl PartialEq for QueryMetrics

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for QueryMetrics