Struct DataStream

pub struct DataStream { /* private fields */ }

The data_stream fields take part in defining the new data stream naming scheme.

In the new data stream naming scheme the value of the data stream fields combine to the name of the actual data stream in the following manner: {data_stream.type}-{data_stream.dataset}-{data_stream.namespace}. This means the fields can only contain characters that are valid as part of names of data streams. More details about this can be found in this blog post.

An Elasticsearch data stream consists of one or more backing indices, and a data stream name forms part of the backing indices names. Due to this convention, data streams must also follow index naming restrictions. For example, data stream names cannot include \, /, *, ?, ", <, >, |, (space character), ,, or #. Please see the Elasticsearch reference for additional restrictions.

Implementations

impl DataStream

pub fn get_type(&self) -> Option<&String>

An overarching type for the data stream.

Currently allowed values are “logs” and “metrics”. We expect to also add “traces” and “synthetics” in the near future.

pub fn set_type(&mut self, type_arg: String)

An overarching type for the data stream.

Currently allowed values are “logs” and “metrics”. We expect to also add “traces” and “synthetics” in the near future.

Example

logs

pub fn get_dataset(&self) -> Option<&String>

The field can contain anything that makes sense to signify the source of the data.

Examples include nginx.access, prometheus, endpoint etc. For data streams that otherwise fit, but that do not have dataset set we use the value “generic” for the dataset value. event.dataset should have the same value as data_stream.dataset.

Beyond the Elasticsearch data stream naming criteria noted above, the dataset value has additional restrictions:

• Must not contain -

• No longer than 100 characters

pub fn set_dataset(&mut self, dataset_arg: String)

The field can contain anything that makes sense to signify the source of the data.

Examples include nginx.access, prometheus, endpoint etc. For data streams that otherwise fit, but that do not have dataset set we use the value “generic” for the dataset value. event.dataset should have the same value as data_stream.dataset.

Beyond the Elasticsearch data stream naming criteria noted above, the dataset value has additional restrictions:

• Must not contain -

• No longer than 100 characters

Example

nginx.access

pub fn get_namespace(&self) -> Option<&String>

A user defined namespace. Namespaces are useful to allow grouping of data.

Many users already organize their indices this way, and the data stream naming scheme now provides this best practice as a default. Many users will populate this field with default. If no value is used, it falls back to default.

Beyond the Elasticsearch index naming criteria noted above, namespace value has the additional restrictions:

• Must not contain -

• No longer than 100 characters

pub fn set_namespace(&mut self, namespace_arg: String)

A user defined namespace. Namespaces are useful to allow grouping of data.

Many users already organize their indices this way, and the data stream naming scheme now provides this best practice as a default. Many users will populate this field with default. If no value is used, it falls back to default.

Beyond the Elasticsearch index naming criteria noted above, namespace value has the additional restrictions:

• Must not contain -

• No longer than 100 characters

Example

production

Trait Implementations

impl Clone for DataStream

fn clone(&self) -> DataStream

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for DataStream

fn default() -> DataStream

Returns the “default value” for a type.

impl Serialize for DataStream

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

where __S: Serializer,

Serialize this value into the given Serde serializer.