Struct InstrumentationOptions

pub struct InstrumentationOptions {
    pub record_metrics: bool,
    pub preview_limit: usize,
    pub preview_fn: Option<Arc<dyn Fn(&RecordBatch) -> Result<String, ArrowError> + Send + Sync>>,
    pub custom_fields: HashMap<String, String>,
}

Configuration options for instrumented execution plans.

Fields

record_metrics: bool

Whether to record metrics during execution.

preview_limit: usize

Maximum number of rows to preview per span.

If set to 0, batch preview recording will be disabled.

preview_fn: Option<Arc<dyn Fn(&RecordBatch) -> Result<String, ArrowError> + Send + Sync>>

Optional callback function for formatting previewed record batches.

The provided function will be invoked for each previewed batch of at most preview_limit rows.

custom_fields: HashMap<String, String>

User-defined custom fields for extensible configuration.

This can be used to store arbitrary key-value pairs relevant to instrumentation or metadata.

Implementations

impl InstrumentationOptions

pub fn builder() -> InstrumentationOptionsBuilder

Creates a new builder for InstrumentationOptions.

Trait Implementations

impl Clone for InstrumentationOptions

fn clone(&self) -> InstrumentationOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for InstrumentationOptions

fn default() -> InstrumentationOptions

Returns the “default value” for a type.