Class InternalEventMetricType<SpecificExtraMap>

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

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

Type Parameters

SpecificExtraMap extends ExtraMap = ExtraMap

Hierarchy (view full)

MetricType
- InternalEventMetricType

Index

Constructors

Properties

allowedExtraKeys? category disabled dynamicLabel? lifetime name sendInPings type

Methods

baseIdentifier identifier record shouldRecord testGetNumRecordedErrors testGetValue

Constructors

constructor

new InternalEventMetricType<SpecificExtraMap>(meta, allowedExtraKeys?): InternalEventMetricType<SpecificExtraMap>
Type Parameters
- SpecificExtraMap extends ExtraMap = ExtraMap
Parameters
- meta: CommonMetricData
- Optional allowedExtraKeys: string[]
Returns InternalEventMetricType<SpecificExtraMap>
Overrides MetricType.constructor
- Defined in src/core/metrics/types/event.ts:35

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 omitted. Otherwise, it's the combination of the metric's category and name.
Inherited from MetricType.baseIdentifier
- Defined in src/core/metrics/index.ts:81

identifier

identifier(): string
The metric's unique identifier, including the category, name and label.

Returns string
The generated identifier. If category is empty, it's omitted. Otherwise, it's the combination of the metric's category, name and label.
Inherited from MetricType.identifier
- Defined in src/core/metrics/index.ts:95

record

record(extra?, timestamp?): 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.
- timestamp: number = ...
  The event timestamp, defaults to now.
Returns void
- Defined in src/core/metrics/types/event.ts:47

shouldRecord

shouldRecord(uploadEnabled): 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.
Inherited from MetricType.shouldRecord
- Defined in src/core/metrics/index.ts:114

testGetNumRecordedErrors

testGetNumRecordedErrors(errorType, ping?): number
Parameters
- errorType: string
- ping: string = ...
Returns number
Inherited from MetricType.testGetNumRecordedErrors
- Defined in src/core/metrics/index.ts:118

testGetValue

testGetValue(ping?): undefined | Event[]
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 undefined | Event[]
The value found in storage or undefined if nothing was found.
- Defined in src/core/metrics/types/event.ts:115

Generated using TypeDoc