exporter::logs::OStreamLogRecordExporter Class Reference

Detailed Description

The OStreamLogRecordExporter exports logs through an ostream (default set to std::cout)

Definition at line 29 of file includes/opentelemetry/exporters/ostream/log_record_exporter.h.

Inheritance diagram for exporter::logs::OStreamLogRecordExporter:

Collaboration diagram for exporter::logs::OStreamLogRecordExporter:

Public Member Functions
	OStreamLogRecordExporter (std::ostream &sout=std::cout) noexcept
	Create an OStreamLogRecordExporter. More...
std::unique_ptr< sdk::logs::Recordable >	MakeRecordable () noexcept override
opentelemetry::sdk::common::ExportResult	Export (const opentelemetry::nostd::span< std::unique_ptr< sdk::logs::Recordable >> &records) noexcept override
	Exports a span of logs sent from the processor. 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
	Marks the OStream Log Exporter as shut down. More...
	OStreamLogRecordExporter (std::ostream &sout=std::cout) noexcept
	Create an OStreamLogRecordExporter. More...
std::unique_ptr< sdk::logs::Recordable >	MakeRecordable () noexcept override
opentelemetry::sdk::common::ExportResult	Export (const opentelemetry::nostd::span< std::unique_ptr< sdk::logs::Recordable >> &records) noexcept override
	Exports a span of logs sent from the processor. 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
	Marks the OStream Log Exporter as shut down. More...

Constructor & Destructor Documentation

OStreamLogRecordExporter() [1/2]

exporter::logs::OStreamLogRecordExporter::OStreamLogRecordExporter ( std::ostream &  sout = std::cout )

explicitnoexcept

Create an OStreamLogRecordExporter.

This constructor takes in a reference to an ostream that the Export() method will send log data into. The default ostream is set to stdout.

OStreamLogRecordExporter() [2/2]

exporter::logs::OStreamLogRecordExporter::OStreamLogRecordExporter ( std::ostream &  sout = std::cout )

explicitnoexcept

Create an OStreamLogRecordExporter.

This constructor takes in a reference to an ostream that the Export() method will send log data into. The default ostream is set to stdout.

Member Function Documentation

Export() [1/2]

opentelemetry::sdk::common::ExportResult exporter::logs::OStreamLogRecordExporter::Export ( const opentelemetry::nostd::span< std::unique_ptr< sdk::logs::Recordable >> &  records )

overridenoexcept

Exports a span of logs sent from the processor.

Export() [2/2]

opentelemetry::sdk::common::ExportResult exporter::logs::OStreamLogRecordExporter::Export ( const opentelemetry::nostd::span< std::unique_ptr< sdk::logs::Recordable >> &  records )

overridenoexcept

Exports a span of logs sent from the processor.

ForceFlush() [1/2]

bool exporter::logs::OStreamLogRecordExporter::ForceFlush ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)() )

overridenoexcept

Force flush the exporter.

Parameters

timeout

an option timeout, default to max.

Returns

return true when all data are exported, and false when timeout

ForceFlush() [2/2]

bool exporter::logs::OStreamLogRecordExporter::ForceFlush ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)() )

overridenoexcept

Force flush the exporter.

Parameters

timeout

an option timeout, default to max.

Returns

return true when all data are exported, and false when timeout

MakeRecordable() [1/2]

std::unique_ptr<sdk::logs::Recordable> exporter::logs::OStreamLogRecordExporter::MakeRecordable ( )

overridenoexcept

MakeRecordable() [2/2]

std::unique_ptr<sdk::logs::Recordable> exporter::logs::OStreamLogRecordExporter::MakeRecordable ( )

overridenoexcept

Shutdown() [1/2]

bool exporter::logs::OStreamLogRecordExporter::Shutdown ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)() )

overridenoexcept

Marks the OStream Log Exporter as shut down.

Shutdown() [2/2]

bool exporter::logs::OStreamLogRecordExporter::Shutdown ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)() )

overridenoexcept

Marks the OStream Log Exporter as shut down.

---

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

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