Enum EntityId 

pub enum EntityId {
    Global,
    PodUid(MetaString),
    Container(MetaString),
    ContainerInode(u64),
    ContainerPid(u32),
}

An entity identifier.

Variants

Global

The global entity.

Represents the root of the entity hierarchy, which is equivalent to a “global” scope. This is generally used to represent a collection of metadata entries that are not associated with any specific entity, but with anything within the workload, such as host or cluster tags.

PodUid(MetaString)

A Kubernetes pod UID.

Represents the UUID of a specific Kubernetes pod.

Container(MetaString)

A container ID.

This is generally a long hexadecimal string, as generally used by container runtimes like containerd.

ContainerInode(u64)

A container inode.

Represents the inode of the cgroups controller for a specific container.

ContainerPid(u32)

A container PID.

Represents the PID of the process within a specific container.

Implementations

impl EntityId

pub fn from_raw_container_id<S>(raw_container_id: S) -> Option<Self>

where S: AsRef<str> + Into<MetaString>,

Creates an EntityId from a raw container ID.

This method handles two special cases when the raw container ID is prefixed with “ci-” or “in-”:

• “ci-” indicates that the raw container ID is a real container ID, but just with an identifying prefix. The prefix is stripped and the remainder is treated as the container ID.
• “in-” indicates that the raw container ID is actually the inode of the cgroups controller for a container. The prefix is stripped and the remainder is parsed as an integer, and the result is treated as the container inode.

If the raw container ID does not start with either of these prefixes, we assume the entire value is the container ID. If the raw container ID starts with the “in-” prefix, but the remainder is not a valid integer, None is returned.

pub fn from_pod_uid<S>(pod_uid: S) -> Option<Self>

where S: AsRef<str> + Into<MetaString>,

Creates an EntityId from a Kubernetes pod UID.

If the pod UID value is “none”, this will return None.

pub fn try_into_container(self) -> Option<MetaString>

Returns the inner container ID value, if this entity ID is a Container.

Otherwise, None is returned and the original entity ID is consumed.

Trait Implementations

impl Clone for EntityId

fn clone(&self) -> EntityId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EntityId

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

Formats the value using the given formatter.

impl Display for EntityId

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

Formats the value using the given formatter.

impl Hash for EntityId

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 PartialEq for EntityId

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for EntityId

impl StructuralPartialEq for EntityId