exporter::metrics::OStreamMetricExporter Class Reference

Detailed Description

The OStreamMetricExporter exports record data through an ostream.

Definition at line 31 of file includes/opentelemetry/exporters/ostream/metric_exporter.h.

Inheritance diagram for exporter::metrics::OStreamMetricExporter:

Collaboration diagram for exporter::metrics::OStreamMetricExporter:

Public Member Functions
	OStreamMetricExporter (std::ostream &sout=std::cout, sdk::metrics::AggregationTemporality aggregation_temporality=sdk::metrics::AggregationTemporality::kCumulative) noexcept
	Create an OStreamMetricExporter. More...
sdk::common::ExportResult	Export (const sdk::metrics::ResourceMetrics &data) noexcept override
	Export. More...
sdk::metrics::AggregationTemporality	GetAggregationTemporality (sdk::metrics::InstrumentType instrument_type) const noexcept override
	Get the AggregationTemporality for ostream exporter. More...
bool	ForceFlush (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept override
	Force flush the exporter. More...
bool	Shutdown (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept override
	Shut down the exporter. More...
	OStreamMetricExporter (std::ostream &sout=std::cout, sdk::metrics::AggregationTemporality aggregation_temporality=sdk::metrics::AggregationTemporality::kCumulative) noexcept
	Create an OStreamMetricExporter. More...
sdk::common::ExportResult	Export (const sdk::metrics::ResourceMetrics &data) noexcept override
	Export. More...
sdk::metrics::AggregationTemporality	GetAggregationTemporality (sdk::metrics::InstrumentType instrument_type) const noexcept override
	Get the AggregationTemporality for ostream exporter. More...
bool	ForceFlush (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept override
	Force flush the exporter. More...
bool	Shutdown (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept override
	Shut down the exporter. More...

Constructor & Destructor Documentation

OStreamMetricExporter() [1/2]

exporter::metrics::OStreamMetricExporter::OStreamMetricExporter ( std::ostream &  sout = std::cout, sdk::metrics::AggregationTemporality  aggregation_temporality = sdk::metrics::AggregationTemporality::kCumulative  )

explicitnoexcept

Create an OStreamMetricExporter.

This constructor takes in a reference to an ostream that the export() function will send metrics data into. The default ostream is set to stdout

OStreamMetricExporter() [2/2]

exporter::metrics::OStreamMetricExporter::OStreamMetricExporter ( std::ostream &  sout = std::cout, sdk::metrics::AggregationTemporality  aggregation_temporality = sdk::metrics::AggregationTemporality::kCumulative  )

explicitnoexcept

Create an OStreamMetricExporter.

This constructor takes in a reference to an ostream that the export() function will send metrics data into. The default ostream is set to stdout

Member Function Documentation

Export() [1/2]

sdk::common::ExportResult exporter::metrics::OStreamMetricExporter::Export ( const sdk::metrics::ResourceMetrics &  data )

overridenoexcept

Export.

Parameters

data	metrics data

Export() [2/2]

sdk::common::ExportResult exporter::metrics::OStreamMetricExporter::Export ( const sdk::metrics::ResourceMetrics &  data )

overridenoexcept

Export.

Parameters

data	metrics data

ForceFlush() [1/2]

bool exporter::metrics::OStreamMetricExporter::ForceFlush ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)() )

overridenoexcept

Force flush the exporter.

ForceFlush() [2/2]

bool exporter::metrics::OStreamMetricExporter::ForceFlush ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)() )

overridenoexcept

Force flush the exporter.

GetAggregationTemporality() [1/2]

sdk::metrics::AggregationTemporality exporter::metrics::OStreamMetricExporter::GetAggregationTemporality ( sdk::metrics::InstrumentType  instrument_type ) const

overridenoexcept

Get the AggregationTemporality for ostream exporter.

Returns

AggregationTemporality

GetAggregationTemporality() [2/2]

sdk::metrics::AggregationTemporality exporter::metrics::OStreamMetricExporter::GetAggregationTemporality ( sdk::metrics::InstrumentType  instrument_type ) const

overridenoexcept

Get the AggregationTemporality for ostream exporter.

Returns

AggregationTemporality

Shutdown() [1/2]

bool exporter::metrics::OStreamMetricExporter::Shutdown ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)() )

overridenoexcept

Shut down the exporter.

Parameters

timeout

an optional timeout.

Returns

return the status of this operation

Shutdown() [2/2]

bool exporter::metrics::OStreamMetricExporter::Shutdown ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)() )

overridenoexcept

Shut down the exporter.

Parameters

timeout

an optional timeout.

Returns

return the status of this operation

---

The documentation for this class was generated from the following file:

• includes/opentelemetry/exporters/ostream/metric_exporter.h