application_telemetry_options Class Reference

#include <couchbase/application_telemetry_options.hxx>

Classes
struct	built

Public Member Functions
auto	enable (bool enable) -> application_telemetry_options &
	Whether to enable application telemetry.
auto	ping_interval (std::chrono::milliseconds interval) -> application_telemetry_options &
	How often the SDK should ping application service telemetry collector.
auto	ping_timeout (std::chrono::milliseconds timeout) -> application_telemetry_options &
	How long the SDK should wait for ping response (pong frame) back from application service telemetry collector.
auto	override_endpoint (std::string endpoint) -> application_telemetry_options &
	Override the endpoint for the application service telementry.
auto	backoff_interval (std::chrono::milliseconds interval) -> application_telemetry_options &
	How long should the SDK wait between connection attempts to the collector to avoid performance and stability issues on the collector side.
auto	build () const -> built

Static Public Attributes
static constexpr std::chrono::milliseconds	default_ping_interval { std::chrono::seconds{ 30 } }
static constexpr std::chrono::milliseconds	default_ping_timeout { std::chrono::seconds{ 2 } }
static constexpr std::chrono::milliseconds	default_backoff_interval { std::chrono::hours{ 1 } }

Member Function Documentation

backoff_interval()

auto backoff_interval ( std::chrono::milliseconds interval ) -> application_telemetry_options &

inline

How long should the SDK wait between connection attempts to the collector to avoid performance and stability issues on the collector side.

Parameters

interval

backoff interval in milliseconds

Since

1.1.0

build()

auto build ( ) const -> built

inlinenodiscard

enable()

auto enable ( bool enable ) -> application_telemetry_options &

inline

Whether to enable application telemetry.

Parameters

enable

true if the application service telemetry have to be enabled.

Since

1.1.0

override_endpoint()

auto override_endpoint ( std::string endpoint ) -> application_telemetry_options &

inline

Override the endpoint for the application service telementry.

The endpoint must use WebSocket protocol and the string should start from ws:// and might have URL path.

Parameters

endpoint

connection string for the telementry collector.

Since

1.1.0

ping_interval()

auto ping_interval ( std::chrono::milliseconds interval ) -> application_telemetry_options &

inline

How often the SDK should ping application service telemetry collector.

Parameters

interval

ping interval in milliseconds.

Since

1.1.0

ping_timeout()

auto ping_timeout ( std::chrono::milliseconds timeout ) -> application_telemetry_options &

inline

How long the SDK should wait for ping response (pong frame) back from application service telemetry collector.

Parameters

timeout

ping timeout in milliseconds.

Since

1.1.0

Member Data Documentation

default_backoff_interval

std::chrono::milliseconds default_backoff_interval { std::chrono::hours{ 1 } }

staticconstexpr

default_ping_interval

std::chrono::milliseconds default_ping_interval { std::chrono::seconds{ 30 } }

staticconstexpr

default_ping_timeout

std::chrono::milliseconds default_ping_timeout { std::chrono::seconds{ 2 } }

staticconstexpr

---

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

• couchbase/application_telemetry_options.hxx