Detailed Description

The OTLP exporter exports log data in OpenTelemetry Protocol (OTLP) format in gRPC.

Definition at line 36 of file includes/opentelemetry/exporters/otlp/otlp_grpc_log_record_exporter.h.

Inheritance diagram for exporter::otlp::OtlpGrpcLogRecordExporter:

Collaboration diagram for exporter::otlp::OtlpGrpcLogRecordExporter:

Public Member Functions
	OtlpGrpcLogRecordExporter ()
	Create an OtlpGrpcLogRecordExporter with default exporter options. More...

	OtlpGrpcLogRecordExporter (const OtlpGrpcLogRecordExporterOptions &options, const std::shared_ptr< OtlpGrpcClient > &client)
	Create an OtlpGrpcLogRecordExporter using specified OtlpGrpcClient. More...

	OtlpGrpcLogRecordExporter (const OtlpGrpcLogRecordExporterOptions &options)
	Create an OtlpGrpcLogRecordExporter with user specified options. More...

	~OtlpGrpcLogRecordExporter () override

	OtlpGrpcLogRecordExporter (const OtlpGrpcLogRecordExporter &)=delete

	OtlpGrpcLogRecordExporter (OtlpGrpcLogRecordExporter &&)=delete

OtlpGrpcLogRecordExporter &	operator= (const OtlpGrpcLogRecordExporter &)=delete

OtlpGrpcLogRecordExporter &	operator= (OtlpGrpcLogRecordExporter &&)=delete

std::unique_ptr< opentelemetry::sdk::logs::Recordable >	MakeRecordable () noexcept override
	Creates a recordable that stores the data in protobuf. More...

opentelemetry::sdk::common::ExportResult	Export (const nostd::span< std::unique_ptr< opentelemetry::sdk::logs::Recordable >> &records) noexcept override
	Exports a vector of log records to the configured gRPC endpoint. 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
	Shutdown this exporter. More...

const std::shared_ptr< OtlpGrpcClient > &	GetClient () const noexcept
	Get the Client object. More...

	OtlpGrpcLogRecordExporter ()
	Create an OtlpGrpcLogRecordExporter with default exporter options. More...

	OtlpGrpcLogRecordExporter (const OtlpGrpcLogRecordExporterOptions &options, const std::shared_ptr< OtlpGrpcClient > &client)
	Create an OtlpGrpcLogRecordExporter using specified OtlpGrpcClient. More...

	OtlpGrpcLogRecordExporter (const OtlpGrpcLogRecordExporterOptions &options)
	Create an OtlpGrpcLogRecordExporter with user specified options. More...

	~OtlpGrpcLogRecordExporter () override

	OtlpGrpcLogRecordExporter (const OtlpGrpcLogRecordExporter &)=delete

	OtlpGrpcLogRecordExporter (OtlpGrpcLogRecordExporter &&)=delete

OtlpGrpcLogRecordExporter &	operator= (const OtlpGrpcLogRecordExporter &)=delete

OtlpGrpcLogRecordExporter &	operator= (OtlpGrpcLogRecordExporter &&)=delete

std::unique_ptr< opentelemetry::sdk::logs::Recordable >	MakeRecordable () noexcept override
	Creates a recordable that stores the data in protobuf. More...

opentelemetry::sdk::common::ExportResult	Export (const nostd::span< std::unique_ptr< opentelemetry::sdk::logs::Recordable >> &records) noexcept override
	Exports a vector of log records to the configured gRPC endpoint. 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
	Shutdown this exporter. More...

const std::shared_ptr< OtlpGrpcClient > &	GetClient () const noexcept
	Get the Client object. More...

Friends
class	OtlpGrpcLogRecordExporterTestPeer

Constructor & Destructor Documentation

◆ OtlpGrpcLogRecordExporter() [1/10]

exporter::otlp::OtlpGrpcLogRecordExporter::OtlpGrpcLogRecordExporter ( )

Create an OtlpGrpcLogRecordExporter with default exporter options.

◆ OtlpGrpcLogRecordExporter() [2/10]

exporter::otlp::OtlpGrpcLogRecordExporter::OtlpGrpcLogRecordExporter	(	const OtlpGrpcLogRecordExporterOptions &	options,
		const std::shared_ptr< OtlpGrpcClient > &	client
	)

Create an OtlpGrpcLogRecordExporter using specified OtlpGrpcClient.

Parameters

options	options to create exporter
client	the gRPC client to use

◆ OtlpGrpcLogRecordExporter() [3/10]

exporter::otlp::OtlpGrpcLogRecordExporter::OtlpGrpcLogRecordExporter ( const OtlpGrpcLogRecordExporterOptions & options )

Create an OtlpGrpcLogRecordExporter with user specified options.

Parameters

options An object containing the user's configuration options.

◆ ~OtlpGrpcLogRecordExporter() [1/2]

exporter::otlp::OtlpGrpcLogRecordExporter::~OtlpGrpcLogRecordExporter ( )

override

◆ OtlpGrpcLogRecordExporter() [4/10]

exporter::otlp::OtlpGrpcLogRecordExporter::OtlpGrpcLogRecordExporter ( const OtlpGrpcLogRecordExporter & )

delete

◆ OtlpGrpcLogRecordExporter() [5/10]

exporter::otlp::OtlpGrpcLogRecordExporter::OtlpGrpcLogRecordExporter ( OtlpGrpcLogRecordExporter && )

delete

◆ OtlpGrpcLogRecordExporter() [6/10]

exporter::otlp::OtlpGrpcLogRecordExporter::OtlpGrpcLogRecordExporter ( )

Create an OtlpGrpcLogRecordExporter with default exporter options.

◆ OtlpGrpcLogRecordExporter() [7/10]

exporter::otlp::OtlpGrpcLogRecordExporter::OtlpGrpcLogRecordExporter	(	const OtlpGrpcLogRecordExporterOptions &	options,
		const std::shared_ptr< OtlpGrpcClient > &	client
	)

Create an OtlpGrpcLogRecordExporter using specified OtlpGrpcClient.

Parameters

options	options to create exporter
client	the gRPC client to use

◆ OtlpGrpcLogRecordExporter() [8/10]

exporter::otlp::OtlpGrpcLogRecordExporter::OtlpGrpcLogRecordExporter ( const OtlpGrpcLogRecordExporterOptions & options )

Create an OtlpGrpcLogRecordExporter with user specified options.

Parameters

options An object containing the user's configuration options.

◆ ~OtlpGrpcLogRecordExporter() [2/2]

exporter::otlp::OtlpGrpcLogRecordExporter::~OtlpGrpcLogRecordExporter ( )

override

◆ OtlpGrpcLogRecordExporter() [9/10]

exporter::otlp::OtlpGrpcLogRecordExporter::OtlpGrpcLogRecordExporter ( const OtlpGrpcLogRecordExporter & )

delete

◆ OtlpGrpcLogRecordExporter() [10/10]

exporter::otlp::OtlpGrpcLogRecordExporter::OtlpGrpcLogRecordExporter ( OtlpGrpcLogRecordExporter && )

delete

Member Function Documentation

◆ Export() [1/2]

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

overridenoexcept

Exports a vector of log records to the configured gRPC endpoint.

Guaranteed to return after a timeout specified from the options passed to the constructor.

Parameters

records A list of log records.

◆ Export() [2/2]

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

overridenoexcept

Exports a vector of log records to the configured gRPC endpoint.

Guaranteed to return after a timeout specified from the options passed to the constructor.

Parameters

records A list of log records.

◆ ForceFlush() [1/2]

bool exporter::otlp::OtlpGrpcLogRecordExporter::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::otlp::OtlpGrpcLogRecordExporter::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

◆ GetClient() [1/2]

const std::shared_ptr<OtlpGrpcClient>& exporter::otlp::OtlpGrpcLogRecordExporter::GetClient ( ) const

noexcept

Get the Client object.

Returns: return binded gRPC client

◆ GetClient() [2/2]

const std::shared_ptr<OtlpGrpcClient>& exporter::otlp::OtlpGrpcLogRecordExporter::GetClient ( ) const

noexcept

Get the Client object.

Returns: return binded gRPC client

◆ MakeRecordable() [1/2]

std::unique_ptr<opentelemetry::sdk::logs::Recordable> exporter::otlp::OtlpGrpcLogRecordExporter::MakeRecordable ( )

overridenoexcept

Creates a recordable that stores the data in protobuf.

Returns: a newly initialized Recordable object.

◆ MakeRecordable() [2/2]

std::unique_ptr<opentelemetry::sdk::logs::Recordable> exporter::otlp::OtlpGrpcLogRecordExporter::MakeRecordable ( )

overridenoexcept

Creates a recordable that stores the data in protobuf.

Returns: a newly initialized Recordable object.

◆ operator=() [1/4]

OtlpGrpcLogRecordExporter& exporter::otlp::OtlpGrpcLogRecordExporter::operator= ( const OtlpGrpcLogRecordExporter & )

delete

◆ operator=() [2/4]

OtlpGrpcLogRecordExporter& exporter::otlp::OtlpGrpcLogRecordExporter::operator= ( const OtlpGrpcLogRecordExporter & )

delete

◆ operator=() [3/4]

OtlpGrpcLogRecordExporter& exporter::otlp::OtlpGrpcLogRecordExporter::operator= ( OtlpGrpcLogRecordExporter && )

delete

◆ operator=() [4/4]

OtlpGrpcLogRecordExporter& exporter::otlp::OtlpGrpcLogRecordExporter::operator= ( OtlpGrpcLogRecordExporter && )

delete

◆ Shutdown() [1/2]

bool exporter::otlp::OtlpGrpcLogRecordExporter::Shutdown ( std::chrono::microseconds timeout = (std::chrono::microseconds::max)() )

overridenoexcept

Shutdown this exporter.

Parameters

timeout The maximum time to wait for the shutdown method to return.

◆ Shutdown() [2/2]

bool exporter::otlp::OtlpGrpcLogRecordExporter::Shutdown ( std::chrono::microseconds timeout = (std::chrono::microseconds::max)() )

overridenoexcept

Shutdown this exporter.

Parameters

timeout The maximum time to wait for the shutdown method to return.

Friends And Related Function Documentation

◆ OtlpGrpcLogRecordExporterTestPeer

OtlpGrpcLogRecordExporterTestPeer

friend

Definition at line 110 of file includes/opentelemetry/exporters/otlp/otlp_grpc_log_record_exporter.h.

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

includes/opentelemetry/exporters/otlp/otlp_grpc_log_record_exporter.h

NVIDIA DeepStream SDK API Reference

9.2 Release

Detailed Description

Public Member Functions

Friends

Constructor & Destructor Documentation

◆ OtlpGrpcLogRecordExporter() [1/10]

◆ OtlpGrpcLogRecordExporter() [2/10]

◆ OtlpGrpcLogRecordExporter() [3/10]

◆ ~OtlpGrpcLogRecordExporter() [1/2]

◆ OtlpGrpcLogRecordExporter() [4/10]

◆ OtlpGrpcLogRecordExporter() [5/10]

◆ OtlpGrpcLogRecordExporter() [6/10]

◆ OtlpGrpcLogRecordExporter() [7/10]

◆ OtlpGrpcLogRecordExporter() [8/10]

◆ ~OtlpGrpcLogRecordExporter() [2/2]

◆ OtlpGrpcLogRecordExporter() [9/10]

◆ OtlpGrpcLogRecordExporter() [10/10]

Member Function Documentation

◆ Export() [1/2]

◆ Export() [2/2]

◆ ForceFlush() [1/2]

◆ ForceFlush() [2/2]

◆ GetClient() [1/2]

◆ GetClient() [2/2]

◆ MakeRecordable() [1/2]

◆ MakeRecordable() [2/2]

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

◆ Shutdown() [1/2]

◆ Shutdown() [2/2]

Friends And Related Function Documentation

◆ OtlpGrpcLogRecordExporterTestPeer