Struct DualLabeledCounterMetric

pub struct DualLabeledCounterMetric { /* private fields */ }

A dual labled metric

Dual labled metrics allow recording multiple sub-metrics of the same type, in relation to two dimensions rather than the single label provided by the standard labeled type.

Implementations

impl DualLabeledCounterMetric

pub fn new( meta: CommonMetricData, keys: Option<Vec<Cow<'static, str>>>, catgories: Option<Vec<Cow<'static, str>>>, ) -> DualLabeledCounterMetric

Creates a new dual labeled counter from the given metric instance and optional list of labels.

pub fn get<S: AsRef<str>>(&self, key: S, category: S) -> Arc<CounterMetric>

Gets a specific metric for a given key/category combination.

If a set of acceptable labels were specified in the metrics.yaml file, and the given label is not in the set, it will be recorded under the special OTHER_LABEL label.

If a set of acceptable labels was not specified in the metrics.yaml file, only the first 16 unique labels will be used. After that, any additional labels will be recorded under the special OTHER_LABEL label.

Labels must have a maximum of 111 characters, and may comprise any printable ASCII characters. If an invalid label is used, the metric will be recorded in the special OTHER_LABEL label.

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

Returns

The number of errors reported.

Trait Implementations

impl Debug for DualLabeledCounterMetric

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

Formats the value using the given formatter.

impl<UT> LiftRef<UT> for DualLabeledCounterMetric

type LiftType = Arc<DualLabeledCounterMetric>

impl<UT> LowerError<UT> for DualLabeledCounterMetric

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for DualLabeledCounterMetric

type ReturnType = <Arc<DualLabeledCounterMetric> as LowerReturn<UniFfiTag>>::ReturnType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl MallocSizeOf for DualLabeledCounterMetric

fn size_of(&self, _ops: &mut MallocSizeOfOps) -> usize

Measure the heap usage of all descendant heap-allocated structures, but not the space taken up by the value itself.

impl MetricType for DualLabeledCounterMetric

fn meta(&self) -> &CommonMetricDataInternal

Access the stored metadata

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

where Self: Sized,

Create a new metric from this with a new name.

fn with_dynamic_label(&self, _label: DynamicLabelType) -> Self

where 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

impl<UT> TypeId<UT> for DualLabeledCounterMetric

const TYPE_ID_META: MetadataBuffer