Struct QueryStatistics

#[non_exhaustive]
pub struct QueryStatistics {
    pub records_matched: f64,
    pub records_scanned: f64,
    pub estimated_records_skipped: f64,
    pub bytes_scanned: f64,
    pub estimated_bytes_skipped: f64,
    pub log_groups_scanned: f64,
}

Contains the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the log events that were scanned.

If the query involved log groups that have field index policies, the estimated number of skipped log events and the total bytes of those skipped log events are included. Using field indexes to skip log events in queries reduces scan volume and improves performance. For more information, see Create field indexes to improve query performance and reduce scan volume.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

records_matched: f64

The number of log events that matched the query string.

records_scanned: f64

The total number of log events scanned during the query.

estimated_records_skipped: f64

An estimate of the number of log events that were skipped when processing this query, because the query contained an indexed field. Skipping these entries lowers query costs and improves the query performance time. For more information about field indexes, see PutIndexPolicy.

bytes_scanned: f64

The total number of bytes in the log events scanned during the query.

estimated_bytes_skipped: f64

An estimate of the number of bytes in the log events that were skipped when processing this query, because the query contained an indexed field. Skipping these entries lowers query costs and improves the query performance time. For more information about field indexes, see PutIndexPolicy.

log_groups_scanned: f64

The number of log groups that were scanned by this query.

Implementations

impl QueryStatistics

pub fn records_matched(&self) -> f64

The number of log events that matched the query string.

pub fn records_scanned(&self) -> f64

The total number of log events scanned during the query.

pub fn estimated_records_skipped(&self) -> f64

An estimate of the number of log events that were skipped when processing this query, because the query contained an indexed field. Skipping these entries lowers query costs and improves the query performance time. For more information about field indexes, see PutIndexPolicy.

pub fn bytes_scanned(&self) -> f64

The total number of bytes in the log events scanned during the query.

pub fn estimated_bytes_skipped(&self) -> f64

An estimate of the number of bytes in the log events that were skipped when processing this query, because the query contained an indexed field. Skipping these entries lowers query costs and improves the query performance time. For more information about field indexes, see PutIndexPolicy.

pub fn log_groups_scanned(&self) -> f64

The number of log groups that were scanned by this query.

impl QueryStatistics

pub fn builder() -> QueryStatisticsBuilder

Creates a new builder-style object to manufacture QueryStatistics.

Trait Implementations

impl Clone for QueryStatistics

fn clone(&self) -> QueryStatistics

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QueryStatistics

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

Formats the value using the given formatter.

impl PartialEq for QueryStatistics

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for QueryStatistics