Struct RandomCutForestConfiguration 

#[non_exhaustive]
pub struct RandomCutForestConfiguration {
    pub query: String,
    pub shingle_size: i32,
    pub sample_size: i32,
    pub ignore_near_expected_from_above: Option<IgnoreNearExpected>,
    pub ignore_near_expected_from_below: Option<IgnoreNearExpected>,
}

Configuration for the Random Cut Forest algorithm used for anomaly detection in time-series data.

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.

query: String

The Prometheus query used to retrieve the time-series data for anomaly detection.

Random Cut Forest queries must be wrapped by a supported PromQL aggregation operator. For more information, see Aggregation operators on the Prometheus docs website.

Supported PromQL aggregation operators: avg, count, group, max, min, quantile, stddev, stdvar, and sum.

shingle_size: i32

The number of consecutive data points used to create a shingle for the Random Cut Forest algorithm. The default number is 8 consecutive data points.

sample_size: i32

The number of data points sampled from the input stream for the Random Cut Forest algorithm. The default number is 256 consecutive data points.

ignore_near_expected_from_above: Option<IgnoreNearExpected>

Configuration for ignoring values that are near expected values from above during anomaly detection.

ignore_near_expected_from_below: Option<IgnoreNearExpected>

Configuration for ignoring values that are near expected values from below during anomaly detection.

Implementations

impl RandomCutForestConfiguration

pub fn query(&self) -> &str

The Prometheus query used to retrieve the time-series data for anomaly detection.

Random Cut Forest queries must be wrapped by a supported PromQL aggregation operator. For more information, see Aggregation operators on the Prometheus docs website.

Supported PromQL aggregation operators: avg, count, group, max, min, quantile, stddev, stdvar, and sum.

pub fn shingle_size(&self) -> i32

The number of consecutive data points used to create a shingle for the Random Cut Forest algorithm. The default number is 8 consecutive data points.

pub fn sample_size(&self) -> i32

The number of data points sampled from the input stream for the Random Cut Forest algorithm. The default number is 256 consecutive data points.

pub fn ignore_near_expected_from_above(&self) -> Option<&IgnoreNearExpected>

Configuration for ignoring values that are near expected values from above during anomaly detection.

pub fn ignore_near_expected_from_below(&self) -> Option<&IgnoreNearExpected>

Configuration for ignoring values that are near expected values from below during anomaly detection.

impl RandomCutForestConfiguration

pub fn builder() -> RandomCutForestConfigurationBuilder

Creates a new builder-style object to manufacture RandomCutForestConfiguration.

Trait Implementations

impl Clone for RandomCutForestConfiguration

fn clone(&self) -> RandomCutForestConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RandomCutForestConfiguration

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

Formats the value using the given formatter.

impl PartialEq for RandomCutForestConfiguration

fn eq(&self, other: &RandomCutForestConfiguration) -> 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 RandomCutForestConfiguration