sdk::logs::MultiLogRecordProcessor Class Reference

Detailed Description

Log processor allow hooks for receive method invocations.

Built-in log processors are responsible for batching and conversion of logs to exportable representation and passing batches to exporters.

Definition at line 25 of file includes/opentelemetry/sdk/logs/multi_log_record_processor.h.

Inheritance diagram for sdk::logs::MultiLogRecordProcessor:

Collaboration diagram for sdk::logs::MultiLogRecordProcessor:

Public Member Functions
	MultiLogRecordProcessor (std::vector< std::unique_ptr< LogRecordProcessor >> &&processors)
	~MultiLogRecordProcessor () override
void	AddProcessor (std::unique_ptr< LogRecordProcessor > &&processor)
std::unique_ptr< Recordable >	MakeRecordable () noexcept override
void	OnEmit (std::unique_ptr< Recordable > &&record) noexcept override
	OnEmit is called by the SDK once a log record has been successfully created. More...
bool	ForceFlush (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept override
	Exports all log records that have not yet been exported to the configured Exporter. More...
bool	Shutdown (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept override
	Shuts down the processor and does any cleanup required. More...
	MultiLogRecordProcessor (std::vector< std::unique_ptr< LogRecordProcessor >> &&processors)
	~MultiLogRecordProcessor () override
void	AddProcessor (std::unique_ptr< LogRecordProcessor > &&processor)
std::unique_ptr< Recordable >	MakeRecordable () noexcept override
void	OnEmit (std::unique_ptr< Recordable > &&record) noexcept override
	OnEmit is called by the SDK once a log record has been successfully created. More...
bool	ForceFlush (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept override
	Exports all log records that have not yet been exported to the configured Exporter. More...
bool	Shutdown (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept override
	Shuts down the processor and does any cleanup required. More...

Protected Member Functions
bool	InternalForceFlush (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept
	Exports all log records that have not yet been exported to the configured Exporter. More...
bool	InternalShutdown (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept
	Shuts down the processor and does any cleanup required. More...
bool	InternalForceFlush (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept
	Exports all log records that have not yet been exported to the configured Exporter. More...
bool	InternalShutdown (std::chrono::microseconds timeout=(std::chrono::microseconds::max)()) noexcept
	Shuts down the processor and does any cleanup required. More...

Constructor & Destructor Documentation

MultiLogRecordProcessor() [1/2]

sdk::logs::MultiLogRecordProcessor::MultiLogRecordProcessor

(

std::vector< std::unique_ptr< LogRecordProcessor >> &&

processors

)

~MultiLogRecordProcessor() [1/2]

sdk::logs::MultiLogRecordProcessor::~MultiLogRecordProcessor ( )

override

MultiLogRecordProcessor() [2/2]

sdk::logs::MultiLogRecordProcessor::MultiLogRecordProcessor

(

std::vector< std::unique_ptr< LogRecordProcessor >> &&

processors

)

~MultiLogRecordProcessor() [2/2]

sdk::logs::MultiLogRecordProcessor::~MultiLogRecordProcessor ( )

override

Member Function Documentation

AddProcessor() [1/2]

void sdk::logs::MultiLogRecordProcessor::AddProcessor

(

std::unique_ptr< LogRecordProcessor > &&

processor

)

AddProcessor() [2/2]

void sdk::logs::MultiLogRecordProcessor::AddProcessor

(

std::unique_ptr< LogRecordProcessor > &&

processor

)

ForceFlush() [1/2]

bool sdk::logs::MultiLogRecordProcessor::ForceFlush ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)() )

overridevirtualnoexcept

Exports all log records that have not yet been exported to the configured Exporter.

Parameters

timeout

that the forceflush is required to finish within.

Returns

a result code indicating whether it succeeded, failed or timed out

Implements sdk::logs::LogRecordProcessor.

ForceFlush() [2/2]

bool sdk::logs::MultiLogRecordProcessor::ForceFlush ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)() )

overridevirtualnoexcept

Exports all log records that have not yet been exported to the configured Exporter.

Parameters

timeout

that the forceflush is required to finish within.

Returns

a result code indicating whether it succeeded, failed or timed out

Implements sdk::logs::LogRecordProcessor.

InternalForceFlush() [1/2]

bool sdk::logs::MultiLogRecordProcessor::InternalForceFlush ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)() )

protectednoexcept

Exports all log records that have not yet been exported to the configured Exporter.

Parameters

timeout

that the forceflush is required to finish within.

Returns

a result code indicating whether it succeeded, failed or timed out

InternalForceFlush() [2/2]

bool sdk::logs::MultiLogRecordProcessor::InternalForceFlush ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)() )

protectednoexcept

Exports all log records that have not yet been exported to the configured Exporter.

Parameters

timeout

that the forceflush is required to finish within.

Returns

a result code indicating whether it succeeded, failed or timed out

InternalShutdown() [1/2]

bool sdk::logs::MultiLogRecordProcessor::InternalShutdown ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)() )

protectednoexcept

Shuts down the processor and does any cleanup required.

ShutDown should only be called once for each processor.

Parameters

timeout

minimum amount of microseconds to wait for shutdown before giving up and returning failure.

Returns

true if the shutdown succeeded, false otherwise

InternalShutdown() [2/2]

bool sdk::logs::MultiLogRecordProcessor::InternalShutdown ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)() )

protectednoexcept

Shuts down the processor and does any cleanup required.

ShutDown should only be called once for each processor.

Parameters

timeout

minimum amount of microseconds to wait for shutdown before giving up and returning failure.

Returns

true if the shutdown succeeded, false otherwise

MakeRecordable() [1/2]

std::unique_ptr<Recordable> sdk::logs::MultiLogRecordProcessor::MakeRecordable ( )

overridevirtualnoexcept

Implements sdk::logs::LogRecordProcessor.

MakeRecordable() [2/2]

std::unique_ptr<Recordable> sdk::logs::MultiLogRecordProcessor::MakeRecordable ( )

overridevirtualnoexcept

Implements sdk::logs::LogRecordProcessor.

OnEmit() [1/2]

void sdk::logs::MultiLogRecordProcessor::OnEmit ( std::unique_ptr< Recordable > &&  record )

overridevirtualnoexcept

OnEmit is called by the SDK once a log record has been successfully created.

Parameters

record

the log record

Implements sdk::logs::LogRecordProcessor.

OnEmit() [2/2]

void sdk::logs::MultiLogRecordProcessor::OnEmit ( std::unique_ptr< Recordable > &&  record )

overridevirtualnoexcept

OnEmit is called by the SDK once a log record has been successfully created.

Parameters

record

the log record

Implements sdk::logs::LogRecordProcessor.

Shutdown() [1/2]

bool sdk::logs::MultiLogRecordProcessor::Shutdown ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)() )

overridevirtualnoexcept

Shuts down the processor and does any cleanup required.

ShutDown should only be called once for each processor.

Parameters

timeout

minimum amount of microseconds to wait for shutdown before giving up and returning failure.

Returns

true if the shutdown succeeded, false otherwise

Implements sdk::logs::LogRecordProcessor.

Shutdown() [2/2]

bool sdk::logs::MultiLogRecordProcessor::Shutdown ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)() )

overridevirtualnoexcept

Shuts down the processor and does any cleanup required.

ShutDown should only be called once for each processor.

Parameters

timeout

minimum amount of microseconds to wait for shutdown before giving up and returning failure.

Returns

true if the shutdown succeeded, false otherwise

Implements sdk::logs::LogRecordProcessor.

---

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

• includes/opentelemetry/sdk/logs/multi_log_record_processor.h