Struct Related 

pub struct Related { /* private fields */ }

This field set is meant to facilitate pivoting around a piece of data.

Some pieces of information can be seen in many places in an ECS event. To facilitate searching for them, store an array of all seen values to their corresponding field in related..

A concrete example is IP addresses, which can be under host, observer, source, destination, client, server, and network.forwarded_ip. If you append all IPs to related.ip, you can then search for a given IP trivially, no matter where it appeared, by querying related.ip:192.0.2.15.

Implementations

impl Related

pub fn get_ip(&self) -> &Vec<String>

All of the IPs seen on your event.

pub fn add_ip(&mut self, ip_arg: String)

All of the IPs seen on your event.

pub fn get_user(&self) -> &Vec<String>

All the user names or other user identifiers seen on the event.

pub fn add_user(&mut self, user_arg: String)

All the user names or other user identifiers seen on the event.

pub fn get_hash(&self) -> &Vec<String>

All the hashes seen on your event. Populating this field, then using it to search for hashes can help in situations where you’re unsure what the hash algorithm is (and therefore which key name to search).

pub fn add_hash(&mut self, hash_arg: String)

All the hashes seen on your event. Populating this field, then using it to search for hashes can help in situations where you’re unsure what the hash algorithm is (and therefore which key name to search).

pub fn get_hosts(&self) -> &Vec<String>

All hostnames or other host identifiers seen on your event. Example identifiers include FQDNs, domain names, workstation names, or aliases.

pub fn add_host(&mut self, host_arg: String)

All hostnames or other host identifiers seen on your event. Example identifiers include FQDNs, domain names, workstation names, or aliases.

Trait Implementations

impl Clone for Related

fn clone(&self) -> Related

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Related

fn default() -> Related

Returns the “default value” for a type.

impl Serialize for Related

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

where __S: Serializer,

Serialize this value into the given Serde serializer.