Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default<SpecificExtraMap>

An event metric.

Type parameters

Hierarchy

Index

Constructors

constructor

Properties

Private Optional allowedExtraKeys

allowedExtraKeys?: string[]

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.

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.

record

  • record(extra?: SpecificExtraMap): void
  • Record an event.

    Parameters

    • Optional extra: SpecificExtraMap

      optional. Used for events where additional richer context is needed. The maximum length for string values is 100 bytes.

    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 | RecordedEvent[]>
  • Test-only API**

    Gets the currently stored events.

    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 | RecordedEvent[]>

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

Static _private_recordUndispatched

  • An internal implemention of record 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<ExtraMap>

      The metric instance to record to.

    • Optional extra: ExtraMap

      optional. Used for events where additional richer context is needed. The maximum length for string values is 100 bytes.

    • timestamp: number = ...

      The event timestamp, defaults to now.

    Returns Promise<void>

    A promise that resolves once the event is recorded.

Generated using TypeDoc