Class OTLPMetricExporter

OTLP-gRPC metric exporter

Hierarchy (View Summary)

OTLPMetricExporterBase
- OTLPMetricExporter

Index

Constructors

Methods

export forceFlush selectAggregation selectAggregationTemporality shutdown

Constructors

constructor

new OTLPMetricExporter(
config?: OTLPGRPCExporterConfigNode & OTLPMetricExporterOptions,
): OTLPMetricExporter
Parameters
- Optionalconfig: OTLPGRPCExporterConfigNode & OTLPMetricExporterOptions
Returns OTLPMetricExporter
Overrides OTLPMetricExporterBase.constructor
- Defined in opentelemetry-exporter-metrics-otlp-grpc/src/OTLPMetricExporter.ts:19

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
Inherited from OTLPMetricExporterBase.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>
Inherited from OTLPMetricExporterBase.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
Inherited from OTLPMetricExporterBase.selectAggregation
- Defined in opentelemetry-exporter-metrics-otlp-http/build/src/OTLPMetricExporterBase.d.ts:13

selectAggregationTemporality

selectAggregationTemporality(
instrumentType: metrics.InstrumentType,
): metrics.AggregationTemporality
Select the AggregationTemporality for the given InstrumentType for this exporter.
Parameters
- instrumentType: metrics.InstrumentType
Returns metrics.AggregationTemporality
Inherited from OTLPMetricExporterBase.selectAggregationTemporality
- Defined in opentelemetry-exporter-metrics-otlp-http/build/src/OTLPMetricExporterBase.d.ts:14

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>
Inherited from OTLPMetricExporterBase.shutdown
- Defined in otlp-exporter-base/build/src/OTLPExporterBase.d.ts:13