Interface PushMetricExporter

An interface that allows different metric services to export recorded data in their own format.

To export data this MUST be registered to the Metrics SDK with a MetricReader.

Hierarchy

PushMetricExporter

Implemented by

Index

Methods

Methods

export

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

- Defined in packages/sdk-metrics/src/export/MetricExporter.ts:35
Called to export sampled ResourceMetrics.

Parameters
- metrics: ResourceMetrics
  
  the metric data to be exported.
- resultCallback: ((result: ExportResult) => void)
  
  callback for when the export has completed
  - - (result: ExportResult): void
    - Parameters
      - result: ExportResult
      Returns void
Returns void

forceFlush

forceFlush(): Promise<void>

- Defined in packages/sdk-metrics/src/export/MetricExporter.ts:44
Ensure that the export of any metrics the exporter has received is completed before the returned promise is settled.

Returns Promise<void>

Optional selectAggregation

selectAggregation(instrumentType: InstrumentType): Aggregation

- Defined in packages/sdk-metrics/src/export/MetricExporter.ts:58
Select the Aggregation for the given InstrumentType for this exporter.

Parameters
- instrumentType: InstrumentType
Returns Aggregation

Optional selectAggregationTemporality

selectAggregationTemporality(instrumentType: InstrumentType): AggregationTemporality

- Defined in packages/sdk-metrics/src/export/MetricExporter.ts:50
Select the AggregationTemporality for the given InstrumentType for this exporter.

Parameters
- instrumentType: InstrumentType
Returns AggregationTemporality

shutdown

shutdown(): Promise<void>

- Defined in packages/sdk-metrics/src/export/MetricExporter.ts:65
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