Struct glean_core::metrics::ObjectMetric

pub struct ObjectMetric { /* private fields */ }

An object metric.

Record structured data. The value must adhere to a predefined structure and is serialized into JSON.

Implementations

impl ObjectMetric

pub fn new(meta: CommonMetricData) -> Self

Creates a new object metric.

pub fn set(&self, value: JsonValue)

Sets to the specified structure.

No additional verification is done. The shape needs to be externally verified.

Arguments

• value - the value to set.

pub fn set_string(&self, object: String)

Sets to the specified structure.

Parses the passed JSON string. If it can’t be parsed into a valid object it records an invalid value error.

Note: This does not check the structure. This needs to be done by the wrapper.

Arguments

• object - JSON representation of the object to set.

pub fn record_schema_error(&self)

Record an InvalidValue error for this metric.

Only to be used by the RLB.

pub fn test_get_value(&self, ping_name: Option<String>) -> Option<JsonValue>

Test-only API (exported for FFI purposes).

Gets the currently stored value as JSON.

This doesn’t clear the stored value.

pub fn test_get_num_recorded_errors(&self, error: ErrorType) -> i32

Exported for test purposes.

Gets the number of recorded errors for the given metric and error type.

Arguments

• error - The type of error
• ping_name - represents the optional name of the ping to retrieve the metric for. inner to the first value in send_in_pings.

Returns

The number of errors reported.

Trait Implementations

impl Clone for ObjectMetric

fn clone(&self) -> ObjectMetric

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectMetric

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

Formats the value using the given formatter.

impl MetricType for ObjectMetric

fn meta(&self) -> &CommonMetricDataInternal

Access the stored metadata

fn with_name(&self, _name: String) -> Selfwhere
    Self: Sized,

Create a new metric from this with a new name.

fn with_dynamic_label(&self, _label: String) -> Selfwhere
    Self: Sized,

Create a new metric from this with a specific label.

fn should_record(&self, glean: &Glean) -> bool

Whether this metric should currently be recorded