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.

Hierarchy

ConsoleMetricExporter

Implements

PushMetricExporter

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ConsoleMetricExporter(options?: ConsoleMetricExporterOptions): ConsoleMetricExporter

- Defined in packages/sdk-metrics/src/export/ConsoleMetricExporter.ts:42
Parameters
- Optional options: ConsoleMetricExporterOptions
Returns ConsoleMetricExporter

Properties

Protected _shutdown

_shutdown: boolean = false

Protected _temporalitySelector

_temporalitySelector: AggregationTemporalitySelector

Methods

export

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

Implementation of PushMetricExporter.export
- Defined in packages/sdk-metrics/src/export/ConsoleMetricExporter.ts:47
Called to export sampled ResourceMetrics.

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/ConsoleMetricExporter.ts:60
Ensure that the export of any metrics the exporter has received is completed before the returned promise is settled.

Returns Promise<void>

selectAggregationTemporality

selectAggregationTemporality(_instrumentType: InstrumentType): AggregationTemporality

Implementation of PushMetricExporter.selectAggregationTemporality
- Defined in packages/sdk-metrics/src/export/ConsoleMetricExporter.ts:64
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/ConsoleMetricExporter.ts:70
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