NVIDIA DeepStream SDK API Reference

9.2 Release
exporter::otlp::OtlpGrpcExporter Class Referencefinal

Detailed Description

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

Definition at line 38 of file includes/opentelemetry/exporters/otlp/otlp_grpc_exporter.h.

Inheritance diagram for exporter::otlp::OtlpGrpcExporter:
Collaboration diagram for exporter::otlp::OtlpGrpcExporter:

Public Member Functions

 OtlpGrpcExporter ()
 Create an OtlpGrpcExporter using all default options. More...
 
 OtlpGrpcExporter (const OtlpGrpcExporterOptions &options, const std::shared_ptr< OtlpGrpcClient > &client)
 Create an OtlpGrpcExporter using specified OtlpGrpcClient. More...
 
 OtlpGrpcExporter (const OtlpGrpcExporterOptions &options)
 Create an OtlpGrpcExporter using the given options. More...
 
 ~OtlpGrpcExporter () override
 
 OtlpGrpcExporter (const OtlpGrpcExporter &)=delete
 
 OtlpGrpcExporter (OtlpGrpcExporter &&)=delete
 
OtlpGrpcExporter & operator= (const OtlpGrpcExporter &)=delete
 
OtlpGrpcExporter & operator= (OtlpGrpcExporter &&)=delete
 
std::unique_ptr< sdk::trace::Recordable > MakeRecordable () noexcept override
 Create a span recordable. More...
 
sdk::common::ExportResult Export (const nostd::span< std::unique_ptr< sdk::trace::Recordable >> &spans) noexcept override
 Export a batch of span recordables in OTLP format. 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...
 
const std::shared_ptr< OtlpGrpcClient > & GetClient () const noexcept
 Get the Client object. More...
 
 OtlpGrpcExporter ()
 Create an OtlpGrpcExporter using all default options. More...
 
 OtlpGrpcExporter (const OtlpGrpcExporterOptions &options, const std::shared_ptr< OtlpGrpcClient > &client)
 Create an OtlpGrpcExporter using specified OtlpGrpcClient. More...
 
 OtlpGrpcExporter (const OtlpGrpcExporterOptions &options)
 Create an OtlpGrpcExporter using the given options. More...
 
 ~OtlpGrpcExporter () override
 
 OtlpGrpcExporter (const OtlpGrpcExporter &)=delete
 
 OtlpGrpcExporter (OtlpGrpcExporter &&)=delete
 
OtlpGrpcExporter & operator= (const OtlpGrpcExporter &)=delete
 
OtlpGrpcExporter & operator= (OtlpGrpcExporter &&)=delete
 
std::unique_ptr< sdk::trace::Recordable > MakeRecordable () noexcept override
 Create a span recordable. More...
 
sdk::common::ExportResult Export (const nostd::span< std::unique_ptr< sdk::trace::Recordable >> &spans) noexcept override
 Export a batch of span recordables in OTLP format. 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...
 
const std::shared_ptr< OtlpGrpcClient > & GetClient () const noexcept
 Get the Client object. More...
 

Friends

class OtlpGrpcExporterTestPeer
 
class OtlpGrpcLogRecordExporterTestPeer
 

Constructor & Destructor Documentation

◆ OtlpGrpcExporter() [1/10]

exporter::otlp::OtlpGrpcExporter::OtlpGrpcExporter ( )

Create an OtlpGrpcExporter using all default options.

◆ OtlpGrpcExporter() [2/10]

exporter::otlp::OtlpGrpcExporter::OtlpGrpcExporter ( const OtlpGrpcExporterOptions &  options,
const std::shared_ptr< OtlpGrpcClient > &  client 
)

Create an OtlpGrpcExporter using specified OtlpGrpcClient.

Parameters
optionsoptions to create exporter
clientthe gRPC client to use

◆ OtlpGrpcExporter() [3/10]

exporter::otlp::OtlpGrpcExporter::OtlpGrpcExporter ( const OtlpGrpcExporterOptions &  options)
explicit

Create an OtlpGrpcExporter using the given options.

◆ ~OtlpGrpcExporter() [1/2]

exporter::otlp::OtlpGrpcExporter::~OtlpGrpcExporter ( )
override

◆ OtlpGrpcExporter() [4/10]

exporter::otlp::OtlpGrpcExporter::OtlpGrpcExporter ( const OtlpGrpcExporter &  )
delete

◆ OtlpGrpcExporter() [5/10]

exporter::otlp::OtlpGrpcExporter::OtlpGrpcExporter ( OtlpGrpcExporter &&  )
delete

◆ OtlpGrpcExporter() [6/10]

exporter::otlp::OtlpGrpcExporter::OtlpGrpcExporter ( )

Create an OtlpGrpcExporter using all default options.

◆ OtlpGrpcExporter() [7/10]

exporter::otlp::OtlpGrpcExporter::OtlpGrpcExporter ( const OtlpGrpcExporterOptions &  options,
const std::shared_ptr< OtlpGrpcClient > &  client 
)

Create an OtlpGrpcExporter using specified OtlpGrpcClient.

Parameters
optionsoptions to create exporter
clientthe gRPC client to use

◆ OtlpGrpcExporter() [8/10]

exporter::otlp::OtlpGrpcExporter::OtlpGrpcExporter ( const OtlpGrpcExporterOptions &  options)
explicit

Create an OtlpGrpcExporter using the given options.

◆ ~OtlpGrpcExporter() [2/2]

exporter::otlp::OtlpGrpcExporter::~OtlpGrpcExporter ( )
override

◆ OtlpGrpcExporter() [9/10]

exporter::otlp::OtlpGrpcExporter::OtlpGrpcExporter ( const OtlpGrpcExporter &  )
delete

◆ OtlpGrpcExporter() [10/10]

exporter::otlp::OtlpGrpcExporter::OtlpGrpcExporter ( OtlpGrpcExporter &&  )
delete

Member Function Documentation

◆ Export() [1/2]

sdk::common::ExportResult exporter::otlp::OtlpGrpcExporter::Export ( const nostd::span< std::unique_ptr< sdk::trace::Recordable >> &  spans)
overridenoexcept

Export a batch of span recordables in OTLP format.

Parameters
spansa span of unique pointers to span recordables

◆ Export() [2/2]

sdk::common::ExportResult exporter::otlp::OtlpGrpcExporter::Export ( const nostd::span< std::unique_ptr< sdk::trace::Recordable >> &  spans)
overridenoexcept

Export a batch of span recordables in OTLP format.

Parameters
spansa span of unique pointers to span recordables

◆ ForceFlush() [1/2]

bool exporter::otlp::OtlpGrpcExporter::ForceFlush ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)())
overridenoexcept

Force flush the exporter.

Parameters
timeoutan option timeout, default to max.
Returns
return true when all data are exported, and false when timeout

◆ ForceFlush() [2/2]

bool exporter::otlp::OtlpGrpcExporter::ForceFlush ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)())
overridenoexcept

Force flush the exporter.

Parameters
timeoutan 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::OtlpGrpcExporter::GetClient ( ) const
noexcept

Get the Client object.

Returns
return binded gRPC client

◆ GetClient() [2/2]

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

Get the Client object.

Returns
return binded gRPC client

◆ MakeRecordable() [1/2]

std::unique_ptr<sdk::trace::Recordable> exporter::otlp::OtlpGrpcExporter::MakeRecordable ( )
overridenoexcept

Create a span recordable.

Returns
a newly initialized Recordable object

◆ MakeRecordable() [2/2]

std::unique_ptr<sdk::trace::Recordable> exporter::otlp::OtlpGrpcExporter::MakeRecordable ( )
overridenoexcept

Create a span recordable.

Returns
a newly initialized Recordable object

◆ operator=() [1/4]

OtlpGrpcExporter& exporter::otlp::OtlpGrpcExporter::operator= ( const OtlpGrpcExporter &  )
delete

◆ operator=() [2/4]

OtlpGrpcExporter& exporter::otlp::OtlpGrpcExporter::operator= ( const OtlpGrpcExporter &  )
delete

◆ operator=() [3/4]

OtlpGrpcExporter& exporter::otlp::OtlpGrpcExporter::operator= ( OtlpGrpcExporter &&  )
delete

◆ operator=() [4/4]

OtlpGrpcExporter& exporter::otlp::OtlpGrpcExporter::operator= ( OtlpGrpcExporter &&  )
delete

◆ Shutdown() [1/2]

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

Shut down the exporter.

Parameters
timeoutan optional timeout, the default timeout of 0 means that no timeout is applied.
Returns
return the status of this operation

◆ Shutdown() [2/2]

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

Shut down the exporter.

Parameters
timeoutan optional timeout, the default timeout of 0 means that no timeout is applied.
Returns
return the status of this operation

Friends And Related Function Documentation

◆ OtlpGrpcExporterTestPeer

OtlpGrpcExporterTestPeer
friend

◆ OtlpGrpcLogRecordExporterTestPeer

OtlpGrpcLogRecordExporterTestPeer
friend

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