Class InMemoryMetricExporter

In-memory Metrics Exporter is a Push Metric Exporter which accumulates metrics data in the local memory and allows to inspect it (useful for e.g. unit tests).

Hierarchy

InMemoryMetricExporter

Implements

PushMetricExporter

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new InMemoryMetricExporter(aggregationTemporality: AggregationTemporality): InMemoryMetricExporter

- Defined in packages/sdk-metrics/src/export/InMemoryMetricExporter.ts:34
Parameters
- aggregationTemporality: AggregationTemporality
Returns InMemoryMetricExporter

Properties

Protected _aggregationTemporality

_aggregationTemporality: AggregationTemporality

Protected _shutdown

_shutdown: boolean = false

Methods

export

export(metrics: ResourceMetrics, resultCallback: ((result: ExportResult) => void)): void

Implementation of PushMetricExporter.export
- Defined in packages/sdk-metrics/src/export/InMemoryMetricExporter.ts:41
inheriteddoc
Parameters
- metrics: ResourceMetrics
- resultCallback: ((result: ExportResult) => void)
  - - (result: ExportResult): void
    - Parameters
      - result: ExportResult
      Returns void
Returns void

forceFlush

forceFlush(): Promise<void>

Implementation of PushMetricExporter.forceFlush
- Defined in packages/sdk-metrics/src/export/InMemoryMetricExporter.ts:63
Ensure that the export of any metrics the exporter has received is completed before the returned promise is settled.

Returns Promise<void>

getMetrics

getMetrics(): ResourceMetrics[]

- Defined in packages/sdk-metrics/src/export/InMemoryMetricExporter.ts:59
Returns all the collected resource metrics

Returns ResourceMetrics[]
ResourceMetrics[]

reset

reset(): void

- Defined in packages/sdk-metrics/src/export/InMemoryMetricExporter.ts:67
Returns void

selectAggregationTemporality

selectAggregationTemporality(_instrumentType: InstrumentType): AggregationTemporality

Implementation of PushMetricExporter.selectAggregationTemporality
- Defined in packages/sdk-metrics/src/export/InMemoryMetricExporter.ts:71
Select the AggregationTemporality for the given InstrumentType for this exporter.

Parameters
- _instrumentType: InstrumentType
Returns AggregationTemporality

shutdown

shutdown(): Promise<void>

Implementation of PushMetricExporter.shutdown
- Defined in packages/sdk-metrics/src/export/InMemoryMetricExporter.ts:77
Returns a promise which resolves when the last exportation is completed. Further calls to PushMetricExporter.export may not export the data.

Returns Promise<void>

Generated using TypeDoc