Class OTLPMetricExporterBase

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 (View Summary)

OTLPExporterBase<metrics.ResourceMetrics>
- OTLPMetricExporterBase

Implements

metrics.PushMetricExporter

Index

Constructors

Methods

export forceFlush selectAggregation selectAggregationTemporality shutdown

Constructors

constructor

new OTLPMetricExporterBase(
delegate: IOtlpExportDelegate<metrics.ResourceMetrics>,
config?: OTLPMetricExporterOptions,
): OTLPMetricExporterBase
Parameters
- delegate: IOtlpExportDelegate<metrics.ResourceMetrics>
- Optionalconfig: OTLPMetricExporterOptions
Returns OTLPMetricExporterBase
Overrides OTLPExporterBase.constructor
- Defined in opentelemetry-exporter-metrics-otlp-http/src/OTLPMetricExporterBase.ts:119

Methods

export

export(
items: metrics.ResourceMetrics,
resultCallback: (result: core.ExportResult) => void,
): void
Export items.
Parameters
- items: metrics.ResourceMetrics
- resultCallback: (result: core.ExportResult) => void
Returns void
Implementation of PushMetricExporter.export

Inherited from OTLPExporterBase.export
- Defined in otlp-exporter-base/build/src/OTLPExporterBase.d.ts:11

forceFlush

forceFlush(): Promise<void>
Ensure that the export of any metrics the exporter has received is completed before the returned promise is settled.

Returns Promise<void>
Implementation of PushMetricExporter.forceFlush

Inherited from OTLPExporterBase.forceFlush
- Defined in otlp-exporter-base/build/src/OTLPExporterBase.d.ts:12

selectAggregation

selectAggregation(
instrumentType: metrics.InstrumentType,
): metrics.AggregationOption
Select the Aggregation for the given InstrumentType for this exporter.
Parameters
- instrumentType: metrics.InstrumentType
Returns metrics.AggregationOption
Implementation of PushMetricExporter.selectAggregation
- Defined in opentelemetry-exporter-metrics-otlp-http/src/OTLPMetricExporterBase.ts:130

selectAggregationTemporality

selectAggregationTemporality(
instrumentType: metrics.InstrumentType,
): metrics.AggregationTemporality
Select the AggregationTemporality for the given InstrumentType for this exporter.
Parameters
- instrumentType: metrics.InstrumentType
Returns metrics.AggregationTemporality
Implementation of PushMetricExporter.selectAggregationTemporality
- Defined in opentelemetry-exporter-metrics-otlp-http/src/OTLPMetricExporterBase.ts:134

shutdown

shutdown(): Promise<void>
Returns a promise which resolves when the last exportation is completed. Further calls to PushMetricExporter.export may not export the data.

Returns Promise<void>
Implementation of PushMetricExporter.shutdown

Inherited from OTLPExporterBase.shutdown
- Defined in otlp-exporter-base/build/src/OTLPExporterBase.d.ts:13