Struct witchcraft_server::logging::api::MetricLogV1

pub struct MetricLogV1 { /* private fields */ }

Definition of the metric.1 format.

Implementations

impl MetricLogV1

pub fn builder() -> BuilderStage0

Returns a new builder.

pub fn type_(&self) -> &str

pub fn time(&self) -> DateTime<Utc>

pub fn metric_name(&self) -> &str

Dot-delimited name of metric, e.g. com.foundry.compass.api.Compass.http.ping.failures

pub fn metric_type(&self) -> &str

Type of metric being represented, e.g. gauge, histogram, counter

pub fn values(&self) -> &BTreeMap<String, Any>

Observations, measurements and context associated with the metric

pub fn tags(&self) -> &BTreeMap<String, String>

Additional dimensions that describe the instance of the metric

pub fn uid(&self) -> Option<&UserId>

User id (if available)

pub fn sid(&self) -> Option<&SessionId>

Session id (if available)

pub fn token_id(&self) -> Option<&TokenId>

API token id (if available)

pub fn org_id(&self) -> Option<&OrganizationId>

Organization id (if available)

pub fn unsafe_params(&self) -> &BTreeMap<String, Any>

Unsafe metadata describing the event

Trait Implementations

impl Clone for MetricLogV1

fn clone(&self) -> MetricLogV1

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetricLogV1

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MetricLogV1

fn deserialize<D>(d: D) -> Result<MetricLogV1, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<MetricLogV1> for BuilderStage4

fn from(value: MetricLogV1) -> Self

Converts to this type from the input type.

impl Hash for MetricLogV1

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 Ord for MetricLogV1

fn cmp(&self, other: &MetricLogV1) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for MetricLogV1

fn eq(&self, other: &MetricLogV1) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for MetricLogV1

fn partial_cmp(&self, other: &MetricLogV1) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for MetricLogV1

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for MetricLogV1

impl StructuralEq for MetricLogV1

impl StructuralPartialEq for MetricLogV1