Class default

A custom distribution metric.

Index

Constructors

Properties

Methods

accumulateSamples testGetNumRecordedErrors testGetValue

Constructors

constructor

new default(meta, rangeMin, rangeMax, bucketCount, histogramType): default
Parameters
- meta: CommonMetricData
- rangeMin: number
- rangeMax: number
- bucketCount: number
- histogramType: string
Returns default
- Defined in src/core/metrics/types/custom_distribution.ts:218

Properties

`Private` #inner

#inner: InternalCustomDistributionMetricType

Methods

accumulateSamples

accumulateSamples(samples): void
Accumulates the provided signed samples in the metric.

Notes
Discards any negative value in samples and report an ErrorType.InvalidValue for each of them.
Parameters
- samples: number[]
  The vector holding the samples to be recorded by the metric.
Returns void
- Defined in src/core/metrics/types/custom_distribution.ts:243

testGetNumRecordedErrors

testGetNumRecordedErrors(errorType, ping?): number
Test-only API

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 number
The number of errors recorded for the metric.
- Defined in src/core/metrics/types/custom_distribution.ts:268

testGetValue

testGetValue(ping?): undefined | DistributionData
Test-only API
Parameters
- ping: string = ...
  The ping from which we want to retrieve the metrics value from. Defaults to the first value in sendInPings.
Returns undefined | DistributionData
The value found in storage or undefined if nothing was found.
- Defined in src/core/metrics/types/custom_distribution.ts:254

Generated using TypeDoc