NVIDIA DeepStream SDK API Reference

9.2 Release
exporter::memory::InMemorySpanExporter Class Referencefinal

Detailed Description

A in memory exporter that switches a flag once a valid recordable was received and keeps track of all received spans in memory.

Definition at line 33 of file includes/opentelemetry/exporters/memory/in_memory_span_exporter.h.

Inheritance diagram for exporter::memory::InMemorySpanExporter:
Collaboration diagram for exporter::memory::InMemorySpanExporter:

Public Member Functions

 InMemorySpanExporter (size_t buffer_size=MAX_BUFFER_SIZE)
 
std::unique_ptr< sdk::trace::Recordable > MakeRecordable () noexcept override
 
sdk::common::ExportResult Export (const nostd::span< std::unique_ptr< sdk::trace::Recordable >> &recordables) noexcept override
 
virtual bool ForceFlush (std::chrono::microseconds) noexcept override
 
bool Shutdown (std::chrono::microseconds timeout OPENTELEMETRY_MAYBE_UNUSED) noexcept override
 Attempt to shut down the in-memory span exporter. More...
 
std::shared_ptr< InMemorySpanData > GetData () noexcept
 
 InMemorySpanExporter (size_t buffer_size=MAX_BUFFER_SIZE)
 
std::unique_ptr< sdk::trace::Recordable > MakeRecordable () noexcept override
 
sdk::common::ExportResult Export (const nostd::span< std::unique_ptr< sdk::trace::Recordable >> &recordables) noexcept override
 
virtual bool ForceFlush (std::chrono::microseconds) noexcept override
 
bool Shutdown (std::chrono::microseconds timeout OPENTELEMETRY_MAYBE_UNUSED) noexcept override
 Attempt to shut down the in-memory span exporter. More...
 
std::shared_ptr< InMemorySpanData > GetData () noexcept
 

Constructor & Destructor Documentation

◆ InMemorySpanExporter() [1/2]

exporter::memory::InMemorySpanExporter::InMemorySpanExporter ( size_t  buffer_size = MAX_BUFFER_SIZE)
inline
Parameters
buffer_sizean optional value that sets the size of the InMemorySpanData

Definition at line 39 of file includes/opentelemetry/exporters/memory/in_memory_span_exporter.h.

◆ InMemorySpanExporter() [2/2]

exporter::memory::InMemorySpanExporter::InMemorySpanExporter ( size_t  buffer_size = MAX_BUFFER_SIZE)
inline
Parameters
buffer_sizean optional value that sets the size of the InMemorySpanData

Definition at line 39 of file 9.2/includes/opentelemetry/exporters/memory/in_memory_span_exporter.h.

Member Function Documentation

◆ Export() [1/2]

sdk::common::ExportResult exporter::memory::InMemorySpanExporter::Export ( const nostd::span< std::unique_ptr< sdk::trace::Recordable >> &  recordables)
inlineoverridenoexcept
Parameters
recordablesa required span containing unique pointers to the data to add to the InMemorySpanData
Returns
Returns the result of the operation

Definition at line 56 of file includes/opentelemetry/exporters/memory/in_memory_span_exporter.h.

References sdk::common::kFailure, sdk::common::kSuccess, absl::move(), and OTEL_INTERNAL_LOG_ERROR.

◆ Export() [2/2]

sdk::common::ExportResult exporter::memory::InMemorySpanExporter::Export ( const nostd::span< std::unique_ptr< sdk::trace::Recordable >> &  recordables)
inlineoverridenoexcept
Parameters
recordablesa required span containing unique pointers to the data to add to the InMemorySpanData
Returns
Returns the result of the operation

Definition at line 56 of file 9.2/includes/opentelemetry/exporters/memory/in_memory_span_exporter.h.

References sdk::common::kFailure, sdk::common::kSuccess, absl::move(), and OTEL_INTERNAL_LOG_ERROR.

◆ ForceFlush() [1/2]

virtual bool exporter::memory::InMemorySpanExporter::ForceFlush ( std::chrono::microseconds  )
inlineoverridevirtualnoexcept

◆ ForceFlush() [2/2]

virtual bool exporter::memory::InMemorySpanExporter::ForceFlush ( std::chrono::microseconds  )
inlineoverridevirtualnoexcept

◆ GetData() [1/2]

std::shared_ptr<InMemorySpanData> exporter::memory::InMemorySpanExporter::GetData ( )
inlinenoexcept
Returns
Returns a shared pointer to this exporters InMemorySpanData

Definition at line 98 of file includes/opentelemetry/exporters/memory/in_memory_span_exporter.h.

◆ GetData() [2/2]

std::shared_ptr<InMemorySpanData> exporter::memory::InMemorySpanExporter::GetData ( )
inlinenoexcept
Returns
Returns a shared pointer to this exporters InMemorySpanData

Definition at line 98 of file 9.2/includes/opentelemetry/exporters/memory/in_memory_span_exporter.h.

◆ MakeRecordable() [1/2]

std::unique_ptr<sdk::trace::Recordable> exporter::memory::InMemorySpanExporter::MakeRecordable ( )
inlineoverridenoexcept
Returns
Returns a unique pointer to an empty recordable object

Definition at line 46 of file includes/opentelemetry/exporters/memory/in_memory_span_exporter.h.

◆ MakeRecordable() [2/2]

std::unique_ptr<sdk::trace::Recordable> exporter::memory::InMemorySpanExporter::MakeRecordable ( )
inlineoverridenoexcept
Returns
Returns a unique pointer to an empty recordable object

Definition at line 46 of file 9.2/includes/opentelemetry/exporters/memory/in_memory_span_exporter.h.

◆ Shutdown() [1/2]

bool exporter::memory::InMemorySpanExporter::Shutdown ( std::chrono::microseconds timeout  OPENTELEMETRY_MAYBE_UNUSED)
inlineoverridenoexcept

Attempt to shut down the in-memory span exporter.

Parameters
timeoutTimeout is an optional value containing the timeout of the exporter note: passing custom timeout values is not currently supported for this exporter
Returns
Returns the status of the operation

Definition at line 89 of file 9.2/includes/opentelemetry/exporters/memory/in_memory_span_exporter.h.

◆ Shutdown() [2/2]

bool exporter::memory::InMemorySpanExporter::Shutdown ( std::chrono::microseconds timeout  OPENTELEMETRY_MAYBE_UNUSED)
inlineoverridenoexcept

Attempt to shut down the in-memory span exporter.

Parameters
timeoutTimeout is an optional value containing the timeout of the exporter note: passing custom timeout values is not currently supported for this exporter
Returns
Returns the status of the operation

Definition at line 89 of file includes/opentelemetry/exporters/memory/in_memory_span_exporter.h.


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