Class ConsoleMetricExporter

This is an implementation of PushMetricExporter that prints metrics to the console. This class can be used for diagnostic purposes.

NOTE: This PushMetricExporter is intended for diagnostics use only, output rendered to the console may change at any time.

Implements

metrics.PushMetricExporter

Index

Constructors

Properties

_shutdown _temporalitySelector

Methods

export forceFlush selectAggregationTemporality shutdown

Constructors

constructor

new ConsoleMetricExporter(
options?: ConsoleMetricExporterOptions,
): metrics.ConsoleMetricExporter
Parameters
- Optionaloptions: ConsoleMetricExporterOptions
Returns metrics.ConsoleMetricExporter
- Defined in packages/sdk-metrics/build/src/export/ConsoleMetricExporter.d.ts:18

Properties

`Protected`_shutdown

_shutdown: boolean

`Protected`_temporalitySelector

_temporalitySelector: metrics.AggregationTemporalitySelector

Methods

export

export(
metrics: metrics.ResourceMetrics,
resultCallback: (result: core.ExportResult) => void,
): void
Called to export sampled ResourceMetrics.
Parameters
- metrics: metrics.ResourceMetrics
  the metric data to be exported.
- resultCallback: (result: core.ExportResult) => void
  callback for when the export has completed
Returns void
Implementation of PushMetricExporter.export
- Defined in packages/sdk-metrics/build/src/export/ConsoleMetricExporter.d.ts:19

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
- Defined in packages/sdk-metrics/build/src/export/ConsoleMetricExporter.d.ts:20

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 packages/sdk-metrics/build/src/export/ConsoleMetricExporter.d.ts:21

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
- Defined in packages/sdk-metrics/build/src/export/ConsoleMetricExporter.d.ts:22