Struct RawOrigin 

pub struct RawOrigin<'a> { /* private fields */ }

A raw representation of an origin.

Metrics contain metadata about their origin, in terms of the metric’s reason for existing: the metric was ingested via DogStatsD, or was generated by an integration, and so on. However, there is also the concept of a metric originating from a particular entity, such as a specific Kubernetes container. This relates directly to the specific sender of the metric, which is used to enrich the metric with additional tags describing the origin entity.

The origin entity will generally be the process ID of the metric sender, or the container ID, both of which are then generally mapped to the relevant information for the metric, such as the orchestrator-level tags for the container/pod/deployment.

Implementations

impl<'a> RawOrigin<'a>

pub fn is_empty(&self) -> bool

Returns true if the origin information is empty.

pub fn clear_process_id(&mut self)

Unsets the process ID of the sender.

pub fn set_process_id(&mut self, process_id: u32)

Sets the process ID of the sender.

Must be a non-zero value. If the value is zero, it is silently ignored.

pub fn process_id(&self) -> Option<u32>

Returns the process ID of the sender.

pub fn set_container_id(&mut self, container_id: impl Into<Option<&'a str>>)

Sets the container ID of the sender.

pub fn container_id(&self) -> Option<&str>

Returns the container ID of the sender.

pub fn set_pod_uid(&mut self, pod_uid: impl Into<Option<&'a str>>)

Sets the pod UID of the sender.

pub fn pod_uid(&self) -> Option<&str>

Returns the pod UID of the sender.

pub fn set_cardinality( &mut self, cardinality: impl Into<Option<OriginTagCardinality>>, )

Sets the desired cardinality of any tags associated with the entity.

pub fn cardinality(&self) -> Option<OriginTagCardinality>

Returns the desired cardinality of any tags associated with the entity.

pub fn set_external_data(&mut self, external_data: impl Into<Option<&'a str>>)

Sets the external data of the sender.

pub fn external_data(&self) -> Option<&RawExternalData<'a>>

Returns the external data of the sender.

Trait Implementations

impl<'a> Clone for RawOrigin<'a>

fn clone(&self) -> RawOrigin<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for RawOrigin<'a>

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

Formats the value using the given formatter.

impl<'a> Default for RawOrigin<'a>

fn default() -> RawOrigin<'a>

Returns the “default value” for a type.

impl Display for RawOrigin<'_>

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

Formats the value using the given formatter.

impl<'a> Hash for RawOrigin<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq for RawOrigin<'a>

fn eq(&self, other: &RawOrigin<'a>) -> 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<'a> Eq for RawOrigin<'a>

impl<'a> StructuralPartialEq for RawOrigin<'a>