Options
All
  • Public
  • Public/Protected
  • All
Menu

Base implementation of the counter metric type, meant only for Glean internal use.

This class exposes Glean-internal properties and methods of the counter metric type.

Hierarchy

Index

Constructors

Properties

category: string
disabled: boolean
dynamicLabel?: string
lifetime: Lifetime
name: string
sendInPings: string[]
type: string

Methods

  • add(amount?: number): void
  • addUndispatched(amount?: number): Promise<void>
  • An implemention of add that does not dispatch the recording task.

    Important

    This method should never be exposed to users.

    Parameters

    • Optional amount: number

      The amount we want to add.

    Returns Promise<void>

  • 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(): 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.

  • 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(errorType: string, ping?: string): Promise<number>
  • testGetValue(ping?: string): Promise<undefined | number>

Generated using TypeDoc