Options
All
  • Public
  • Public/Protected
  • All
Menu

A MetricType describes common behavior across all metrics.

Hierarchy

Implements

Index

Constructors

Properties

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

Methods

  • 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>

Generated using TypeDoc