glean / mozilla.telemetry.glean.private / StringMetricType

StringMetricType

class StringMetricType

This implements the developer facing API for recording string metrics.

Instances of this class type are automatically generated by the parsers at build time, allowing developers to record values that were previously registered in the metrics.yaml file.

The string API only exposes the set method, which takes care of validating the input data and making sure that limits are enforced.

The internal constructor is only used by LabeledMetricType directly.

Constructors

<init>

StringMetricType(disabled: Boolean, category: String, lifetime: Lifetime, name: String, sendInPings: List<String>)

The public constructor used by automatically generated metrics.

Functions

set

fun set(value: String): Unit

Set a string value.

testGetNumRecordedErrors

fun testGetNumRecordedErrors(errorType: ErrorType, pingName: String = sendInPings.first()): Int

Returns the number of errors recorded for the given metric.

testGetValue

fun testGetValue(pingName: String = sendInPings.first()): String

Returns the stored value for testing purposes only. This function will attempt to await the last task (if any) writing to the the metric's storage engine before returning a value.

testHasValue

fun testHasValue(pingName: String = sendInPings.first()): Boolean

Tests whether a value is stored for the metric for testing purposes only. This function will attempt to await the last task (if any) writing to the the metric's storage engine before returning a value.