Skip to main content

QueryTelemetry

Struct QueryTelemetry 

Source
pub struct QueryTelemetry {
    pub query_id: String,
    pub query_class: String,
    pub start_time: Option<Instant>,
    pub total_duration_us: u64,
    pub routing: RoutingMetrics,
    pub scan: ScanMetrics,
    pub rerank: RerankMetrics,
    pub cache: CacheMetrics,
    pub error_envelope: ErrorEnvelopeMetrics,
    pub termination: TerminationMetrics,
    pub cost: Option<CostSummaryJson>,
    pub tags: HashMap<String, String>,
}
Expand description

Comprehensive per-query telemetry

Fields§

§query_id: String

Query identifier (for correlation)

§query_class: String

Query class (e.g., “low_latency”, “high_recall”)

§start_time: Option<Instant>

Timestamp when query started

§total_duration_us: u64

Total query duration

§routing: RoutingMetrics

Routing phase metrics

§scan: ScanMetrics

Scan phase metrics

§rerank: RerankMetrics

Rerank phase metrics

§cache: CacheMetrics

Cache metrics

§error_envelope: ErrorEnvelopeMetrics

Error envelope metrics

§termination: TerminationMetrics

Termination metrics

§cost: Option<CostSummaryJson>

Cost summary (if budget tracking enabled)

§tags: HashMap<String, String>

Custom tags for filtering/grouping

Implementations§

Source§

impl QueryTelemetry

Source

pub fn new(query_class: &str) -> Self

Create new telemetry for a query

Source

pub fn with_id(query_id: &str, query_class: &str) -> Self

Create with specific query ID

Source

pub fn record_routing( &mut self, duration: Duration, lists_considered: u32, lists_scanned: u32, )

Record routing phase

Source

pub fn record_routing_full( &mut self, duration: Duration, lists_considered: u32, lists_scanned: u32, centroid_comparisons: u32, used_compressed: bool, strategy: &str, )

Record routing with full details

Source

pub fn record_scan(&mut self, codes_evaluated: u64, ram_bytes: u64)

Record scan phase

Source

pub fn record_scan_full( &mut self, duration: Duration, codes_evaluated: u64, ram_bytes: u64, simd_ops: u64, candidates_stage1: u32, distance_metric: &str, quant_level: &str, )

Record scan with full details

Source

pub fn record_rerank( &mut self, duration: Duration, candidates_in: u32, candidates_out: u32, ssd_random_reads: u32, ssd_sequential_bytes: u64, )

Record rerank phase

Source

pub fn record_io_coalescing(&mut self, coalesced: bool, ranges: u32)

Record IO coalescing details

Source

pub fn record_cache_hit(&mut self, cache_type: CacheType)

Record cache hits/misses

Source

pub fn record_cache_miss(&mut self, cache_type: CacheType)

Record cache miss

Source

pub fn set_guarantee_mode(&mut self, mode: &GuaranteeMode)

Set guarantee mode

Source

pub fn record_error_bounds(&mut self, max_error: f32, mean_error: f32)

Record error bounds observed

Source

pub fn set_stop_reason( &mut self, reason: StopReason, probes: u32, max_probes: u32, )

Set stop reason

Source

pub fn set_miss_probability(&mut self, prob: f32)

Set miss probability

Source

pub fn set_result_count(&mut self, count: u32)

Set result count

Source

pub fn attach_cost(&mut self, summary: CostSummary)

Attach cost summary

Source

pub fn add_tag(&mut self, key: &str, value: &str)

Add a custom tag

Source

pub fn finalize(&mut self)

Finalize telemetry (compute total duration)

Source

pub fn to_json(&self) -> String

Serialize to JSON

Source

pub fn to_json_pretty(&self) -> String

Serialize to pretty JSON

Trait Implementations§

Source§

impl Clone for QueryTelemetry

Source§

fn clone(&self) -> QueryTelemetry

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for QueryTelemetry

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for QueryTelemetry

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for QueryTelemetry

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more