Struct vector::enrichment_tables::file::FileConfig

pub struct FileConfig {
    pub file: FileSettings,
    pub schema: HashMap<String, String>,
}

Configuration for the file enrichment table.

Fields

file: FileSettings

File-specific settings.

schema: HashMap<String, String>

Key/value pairs representing mapped log field names and types.

This is used to coerce log fields from strings into their proper types. The available types are listed in the Types list below.

Timestamp coercions need to be prefaced with timestamp|, for example "timestamp|%F". Timestamp specifiers can use either of the following:

1. One of the built-in-formats listed in the Timestamp Formats table below.
2. The time format specifiers from Rust’s chrono library.

Types

• bool
• string
• float
• integer
• date
• timestamp (see the table below for formats)

Timestamp Formats

Format	Description	Example
%F %T	YYYY-MM-DD HH:MM:SS	2020-12-01 02:37:54
%v %T	DD-Mmm-YYYY HH:MM:SS	01-Dec-2020 02:37:54
%FT%T	ISO 8601/RFC 3339, without time zone	2020-12-01T02:37:54
%FT%TZ	ISO 8601/RFC 3339, UTC	2020-12-01T09:37:54Z
%+	ISO 8601/RFC 3339, UTC, with time zone	2020-12-01T02:37:54-07:00
%a, %d %b %Y %T	RFC 822/RFC 2822, without time zone	Tue, 01 Dec 2020 02:37:54
%a %b %e %T %Y	ctime format	Tue Dec 1 02:37:54 2020
%s	UNIX timestamp	1606790274
%a %d %b %T %Y	date command, without time zone	Tue 01 Dec 02:37:54 2020
%a %d %b %T %Z %Y	date command, with time zone	Tue 01 Dec 02:37:54 PST 2020
%a %d %b %T %z %Y	date command, with numeric time zone	Tue 01 Dec 02:37:54 -0700 2020
%a %d %b %T %#z %Y	date command, with numeric time zone (minutes can be missing or present)	Tue 01 Dec 02:37:54 -07 2020

Implementations

impl FileConfig

pub fn load_file(&self, timezone: TimeZone) -> Result<FileData>

Load the configured file into memory. Required to create a new file enrichment table.

Trait Implementations

impl Clone for FileConfig

fn clone(&self) -> FileConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for FileConfig

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 FileConfig

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

Formats the value using the given formatter.

impl Default for FileConfig

fn default() -> FileConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FileConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EnrichmentTableConfig for FileConfig

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

Builds the enrichment table with the given globals.

impl From<FileConfig> for EnrichmentTables

fn from(v: FileConfig) -> EnrichmentTables

Converts to this type from the input type.

impl GenerateConfig for FileConfig

fn generate_config() -> Value

impl NamedComponent for FileConfig

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

Gets the name of the component.

impl PartialEq for FileConfig

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToValue for FileConfig

fn to_value(&self) -> Value

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

impl TryInto<FileConfig> for EnrichmentTables

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for FileConfig

impl StructuralPartialEq for FileConfig