exporter::otlp::OtlpHttpExporter Class Reference

Detailed Description

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

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

Inheritance diagram for exporter::otlp::OtlpHttpExporter:

Collaboration diagram for exporter::otlp::OtlpHttpExporter:

Public Member Functions
	OtlpHttpExporter ()
	Create an OtlpHttpExporter using all default options. More...
	OtlpHttpExporter (const OtlpHttpExporterOptions &options)
	Create an OtlpHttpExporter using the given options. More...
	OtlpHttpExporter (const OtlpHttpExporterOptions &options, const OtlpHttpExporterRuntimeOptions &runtime_options)
	Create an OtlpHttpExporter using the given options. More...
std::unique_ptr< opentelemetry::sdk::trace::Recordable >	MakeRecordable () noexcept override
	Create a span recordable. More...
opentelemetry::sdk::common::ExportResult	Export (const nostd::span< std::unique_ptr< opentelemetry::sdk::trace::Recordable >> &spans) noexcept override
	Export. 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...
	OtlpHttpExporter ()
	Create an OtlpHttpExporter using all default options. More...
	OtlpHttpExporter (const OtlpHttpExporterOptions &options)
	Create an OtlpHttpExporter using the given options. More...
	OtlpHttpExporter (const OtlpHttpExporterOptions &options, const OtlpHttpExporterRuntimeOptions &runtime_options)
	Create an OtlpHttpExporter using the given options. More...
std::unique_ptr< opentelemetry::sdk::trace::Recordable >	MakeRecordable () noexcept override
	Create a span recordable. More...
opentelemetry::sdk::common::ExportResult	Export (const nostd::span< std::unique_ptr< opentelemetry::sdk::trace::Recordable >> &spans) noexcept override
	Export. 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...

Friends
class	OtlpHttpExporterTestPeer

Constructor & Destructor Documentation

OtlpHttpExporter() [1/6]

exporter::otlp::OtlpHttpExporter::OtlpHttpExporter

(

)

Create an OtlpHttpExporter using all default options.

OtlpHttpExporter() [2/6]

exporter::otlp::OtlpHttpExporter::OtlpHttpExporter ( const OtlpHttpExporterOptions &  options )

explicit

Create an OtlpHttpExporter using the given options.

OtlpHttpExporter() [3/6]

exporter::otlp::OtlpHttpExporter::OtlpHttpExporter	(	const OtlpHttpExporterOptions &	options,
		const OtlpHttpExporterRuntimeOptions &	runtime_options
	)

Create an OtlpHttpExporter using the given options.

OtlpHttpExporter() [4/6]

exporter::otlp::OtlpHttpExporter::OtlpHttpExporter

(

)

Create an OtlpHttpExporter using all default options.

OtlpHttpExporter() [5/6]

exporter::otlp::OtlpHttpExporter::OtlpHttpExporter ( const OtlpHttpExporterOptions &  options )

explicit

Create an OtlpHttpExporter using the given options.

OtlpHttpExporter() [6/6]

exporter::otlp::OtlpHttpExporter::OtlpHttpExporter	(	const OtlpHttpExporterOptions &	options,
		const OtlpHttpExporterRuntimeOptions &	runtime_options
	)

Create an OtlpHttpExporter using the given options.

Member Function Documentation

Export() [1/2]

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

overridenoexcept

Export.

Parameters

spans

a span of unique pointers to span recordables

Export() [2/2]

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

overridenoexcept

Export.

Parameters

spans

a span of unique pointers to span recordables

ForceFlush() [1/2]

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

MakeRecordable() [1/2]

std::unique_ptr<opentelemetry::sdk::trace::Recordable> exporter::otlp::OtlpHttpExporter::MakeRecordable ( )

overridenoexcept

Create a span recordable.

Returns

a newly initialized Recordable object

MakeRecordable() [2/2]

std::unique_ptr<opentelemetry::sdk::trace::Recordable> exporter::otlp::OtlpHttpExporter::MakeRecordable ( )

overridenoexcept

Create a span recordable.

Returns

a newly initialized Recordable object

Shutdown() [1/2]

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

overridenoexcept

Shut down the exporter.

Parameters

timeout

an 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::OtlpHttpExporter::Shutdown ( std::chrono::microseconds  timeout = (std::chrono::microseconds::max)() )

overridenoexcept

Shut down the exporter.

Parameters

timeout

an 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

OtlpHttpExporterTestPeer

OtlpHttpExporterTestPeer

friend

Definition at line 86 of file includes/opentelemetry/exporters/otlp/otlp_http_exporter.h.

---

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

• includes/opentelemetry/exporters/otlp/otlp_http_exporter.h