NVIDIA DeepStream SDK API Reference

9.2 Release
exporter::otlp::OtlpHttpLogRecordExporter Class Referencefinal

Detailed Description

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

Definition at line 27 of file includes/opentelemetry/exporters/otlp/otlp_http_log_record_exporter.h.

Inheritance diagram for exporter::otlp::OtlpHttpLogRecordExporter:
Collaboration diagram for exporter::otlp::OtlpHttpLogRecordExporter:

Public Member Functions

 OtlpHttpLogRecordExporter ()
 Create an OtlpHttpLogRecordExporter with default exporter options. More...
 
 OtlpHttpLogRecordExporter (const OtlpHttpLogRecordExporterOptions &options)
 Create an OtlpHttpLogRecordExporter with user specified options. More...
 
 OtlpHttpLogRecordExporter (const OtlpHttpLogRecordExporterOptions &options, const OtlpHttpLogRecordExporterRuntimeOptions &runtime_options)
 Create an OtlpHttpLogRecordExporter with user specified options. More...
 
std::unique_ptr< opentelemetry::sdk::logs::Recordable > MakeRecordable () noexcept override
 Creates a recordable that stores the data in a JSON object. 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 Elasticsearch instance. 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...
 
 OtlpHttpLogRecordExporter ()
 Create an OtlpHttpLogRecordExporter with default exporter options. More...
 
 OtlpHttpLogRecordExporter (const OtlpHttpLogRecordExporterOptions &options)
 Create an OtlpHttpLogRecordExporter with user specified options. More...
 
 OtlpHttpLogRecordExporter (const OtlpHttpLogRecordExporterOptions &options, const OtlpHttpLogRecordExporterRuntimeOptions &runtime_options)
 Create an OtlpHttpLogRecordExporter with user specified options. More...
 
std::unique_ptr< opentelemetry::sdk::logs::Recordable > MakeRecordable () noexcept override
 Creates a recordable that stores the data in a JSON object. 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 Elasticsearch instance. 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...
 

Friends

class OtlpHttpLogRecordExporterTestPeer
 

Constructor & Destructor Documentation

◆ OtlpHttpLogRecordExporter() [1/6]

exporter::otlp::OtlpHttpLogRecordExporter::OtlpHttpLogRecordExporter ( )

Create an OtlpHttpLogRecordExporter with default exporter options.

◆ OtlpHttpLogRecordExporter() [2/6]

exporter::otlp::OtlpHttpLogRecordExporter::OtlpHttpLogRecordExporter ( const OtlpHttpLogRecordExporterOptions &  options)

Create an OtlpHttpLogRecordExporter with user specified options.

Parameters
optionsAn object containing the user's configuration options.

◆ OtlpHttpLogRecordExporter() [3/6]

exporter::otlp::OtlpHttpLogRecordExporter::OtlpHttpLogRecordExporter ( const OtlpHttpLogRecordExporterOptions &  options,
const OtlpHttpLogRecordExporterRuntimeOptions &  runtime_options 
)

Create an OtlpHttpLogRecordExporter with user specified options.

Parameters
optionsAn object containing the user's configuration options.
runtime_optionsAn object containing the user's runtime options.

◆ OtlpHttpLogRecordExporter() [4/6]

exporter::otlp::OtlpHttpLogRecordExporter::OtlpHttpLogRecordExporter ( )

Create an OtlpHttpLogRecordExporter with default exporter options.

◆ OtlpHttpLogRecordExporter() [5/6]

exporter::otlp::OtlpHttpLogRecordExporter::OtlpHttpLogRecordExporter ( const OtlpHttpLogRecordExporterOptions &  options)

Create an OtlpHttpLogRecordExporter with user specified options.

Parameters
optionsAn object containing the user's configuration options.

◆ OtlpHttpLogRecordExporter() [6/6]

exporter::otlp::OtlpHttpLogRecordExporter::OtlpHttpLogRecordExporter ( const OtlpHttpLogRecordExporterOptions &  options,
const OtlpHttpLogRecordExporterRuntimeOptions &  runtime_options 
)

Create an OtlpHttpLogRecordExporter with user specified options.

Parameters
optionsAn object containing the user's configuration options.
runtime_optionsAn object containing the user's runtime options.

Member Function Documentation

◆ Export() [1/2]

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

Exports a vector of log records to the Elasticsearch instance.

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

Parameters
recordsA list of log records to send to Elasticsearch.

◆ Export() [2/2]

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

Exports a vector of log records to the Elasticsearch instance.

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

Parameters
recordsA list of log records to send to Elasticsearch.

◆ ForceFlush() [1/2]

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

◆ MakeRecordable() [1/2]

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

Creates a recordable that stores the data in a JSON object.

◆ MakeRecordable() [2/2]

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

Creates a recordable that stores the data in a JSON object.

◆ Shutdown() [1/2]

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

Shutdown this exporter.

Parameters
timeoutThe maximum time to wait for the shutdown method to return

◆ Shutdown() [2/2]

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

Shutdown this exporter.

Parameters
timeoutThe maximum time to wait for the shutdown method to return

Friends And Related Function Documentation

◆ OtlpHttpLogRecordExporterTestPeer

OtlpHttpLogRecordExporterTestPeer
friend

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