Struct MemoryConfig

pub struct MemoryConfig {
    pub ttl: u64,
    pub scan_interval: NonZeroU64,
    pub flush_interval: Option<u64>,
    pub max_byte_size: Option<u64>,
    pub log_namespace: Option<bool>,
    pub internal_metrics: InternalMetricsConfig,
    pub source_config: Option<MemorySourceConfig>,
    pub ttl_field: OptionalValuePath,
    /* private fields */
}

Configuration for the memory enrichment table.

Fields

ttl: u64

TTL (time-to-live in seconds) is used to limit the lifetime of data stored in the cache. When TTL expires, data behind a specific key in the cache is removed. TTL is reset when the key is replaced.

scan_interval: NonZeroU64

The scan interval used to look for expired records. This is provided as an optimization to ensure that TTL is updated, but without doing too many cache scans.

flush_interval: Option<u64>

The interval used for making writes visible in the table. Longer intervals might get better performance, but there is a longer delay before the data is visible in the table. Since every TTL scan makes its changes visible, only use this value if it is shorter than the scan_interval.

By default, all writes are made visible immediately.

max_byte_size: Option<u64>

Maximum size of the table in bytes. All insertions that make this table bigger than the maximum size are rejected.

By default, there is no size limit.

log_namespace: Option<bool>

The namespace to use for logs. This overrides the global setting.

internal_metrics: InternalMetricsConfig

Configuration of internal metrics

source_config: Option<MemorySourceConfig>

Configuration for source functionality.

ttl_field: OptionalValuePath

Field in the incoming value used as the TTL override.

Trait Implementations

impl Clone for MemoryConfig

fn clone(&self) -> MemoryConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Configurable for MemoryConfig

fn referenceable_name() -> Option<&'static str>

Gets the referenceable name of this value, if any.

fn metadata() -> Metadata

Gets the metadata for this value.

fn generate_schema( schema_gen: &RefCell<SchemaGenerator>, ) -> Result<SchemaObject, GenerateError>

Generates the schema for this value.

fn is_optional() -> bool

where Self: Sized,

Whether or not this value is optional.

fn validate_metadata(_metadata: &Metadata) -> Result<(), GenerateError>

where Self: Sized,

Validates the given metadata against this type.

fn as_configurable_ref() -> ConfigurableRef

where Self: Sized + 'static,

Create a new configurable reference table.

impl Debug for MemoryConfig

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

Formats the value using the given formatter.

impl Default for MemoryConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MemoryConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EnrichmentTableConfig for MemoryConfig

async fn build( &self, _globals: &GlobalOptions, ) -> Result<Box<dyn Table + Send + Sync>>

Builds the enrichment table with the given globals.

fn sink_config( &self, default_key: &ComponentKey, ) -> Option<(ComponentKey, Box<dyn SinkConfig>)>

fn source_config( &self, _default_key: &ComponentKey, ) -> Option<(ComponentKey, Box<dyn SourceConfig>)>

impl From<MemoryConfig> for EnrichmentTables

fn from(v: MemoryConfig) -> EnrichmentTables

Converts to this type from the input type.

impl GenerateConfig for MemoryConfig

fn generate_config() -> Value

impl NamedComponent for MemoryConfig

fn get_component_name(&self) -> &'static str

Gets the name of the component.

impl PartialEq for MemoryConfig

fn eq(&self, other: &Self) -> 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 Serialize for MemoryConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SinkConfig for MemoryConfig

fn build<'life0, 'async_trait>( &'life0 self, _cx: SinkContext, ) -> Pin<Box<dyn Future<Output = Result<(VectorSink, Healthcheck)>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Builds the sink with the given context.

fn input(&self) -> Input

Gets the input configuration for this sink.

fn acknowledgements(&self) -> &AcknowledgementsConfig

Gets the acknowledgements configuration for this sink.

fn files_to_watch(&self) -> Vec<&PathBuf>

Gets the files to watch to trigger reload

fn resources(&self) -> Vec<Resource>

Gets the list of resources, if any, used by this sink.

impl SourceConfig for MemoryConfig

fn build<'life0, 'async_trait>( &'life0 self, cx: SourceContext, ) -> Pin<Box<dyn Future<Output = Result<Source>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Builds the source with the given context.

fn outputs(&self, global_log_namespace: LogNamespace) -> Vec<SourceOutput>

Gets the list of outputs exposed by this source.

fn can_acknowledge(&self) -> bool

Whether or not this source can acknowledge the events it emits.

fn resources(&self) -> Vec<Resource>

Gets the list of resources, if any, used by this source.

impl ToValue for MemoryConfig

fn to_value(&self) -> Value

Convert this value into a serde_json::Value. Must not fail.

impl TryInto<MemoryConfig> for EnrichmentTables

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<MemoryConfig, <Self as TryInto<MemoryConfig>>::Error>

Performs the conversion.

impl Eq for MemoryConfig