Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default

An UUID metric.

Stores UUID v4 (randomly generated) values.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly category

category: string

Readonly disabled

disabled: boolean

Optional dynamicLabel

dynamicLabel?: string

Readonly lifetime

lifetime: Lifetime

Readonly name

name: string

Readonly sendInPings

sendInPings: string[]

Readonly type

type: string

Methods

baseIdentifier

  • baseIdentifier(): string

  • The metric's base identifier, including the category and name, but not the label.

    Returns string

    The generated identifier. If category is empty, it's ommitted. Otherwise, it's the combination of the metric's category and name.

generateAndSet

  • generateAndSet(): undefined | string

  • Generates a new random uuid and sets the metric to it.

    Returns undefined | string

    The generated value or undefined in case this metric shouldn't be recorded.

identifier

  • identifier(): Promise<string>

  • The metric's unique identifier, including the category, name and label.

    Returns Promise<string>

    The generated identifier. If category is empty, it's ommitted. Otherwise, it's the combination of the metric's category, name and label.

set

  • set(value: string): void

  • Sets to the specified value.

    throws

    In case value is not a valid UUID.

    Parameters

    • value: string

      the value to set.

    Returns void

shouldRecord

  • shouldRecord(uploadEnabled: boolean): boolean

  • Verify whether or not this metric instance should be recorded.

    Parameters

    • uploadEnabled: boolean

      Whether or not global upload is enabled or disabled.

    Returns boolean

    Whether or not this metric instance should be recorded.

testGetNumRecordedErrors

  • testGetNumRecordedErrors(errorType: string, ping?: string): Promise<number>

  • Returns the number of errors recorded for the given metric.

    Parameters

    • errorType: string

      The type of the error recorded.

    • ping: string = ...

      represents the name of the ping to retrieve the metric for. Defaults to the first value in sendInPings.

    Returns Promise<number>

    the number of errors recorded for the metric.

testGetValue

  • testGetValue(ping?: string): Promise<undefined | string>

  • Test-only API**

    Gets the currently stored value as a string.

    This doesn't clear the stored value.

    Parameters

    • ping: string = ...

      the ping from which we want to retrieve this metrics value from. Defaults to the first value in sendInPings.

    Returns Promise<undefined | string>

    The value found in storage or undefined if nothing was found.

Static _private_setUndispatched

  • _private_setUndispatched(instance: default, value: string): Promise<void>

  • An internal implemention of set that does not dispatch the recording task.

    Important

    This is absolutely not meant to be used outside of Glean itself. It may cause multiple issues because it cannot guarantee that the recording of the metric will happen in order with other Glean API calls.

    Parameters

    • instance: default

      The metric instance to record to.

    • value: string

      The UUID we want to set to.

    Returns Promise<void>

Generated using TypeDoc