Class AppTelemetryOptions

Inheritance

object

AppTelemetryOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Couchbase.Core.Diagnostics.Metrics.AppTelemetry

Assembly: Couchbase.NetClient.dll

Syntax

[InterfaceStability(Level.Volatile)]
public class AppTelemetryOptions

Properties

Backoff

Configures the maximum backoff for re-connecting to the AppTelemetry endpoint via WebSockets. Re-connecting to the endpoint is done using exponential backoff, up to this maximum value. The default is 1h. This can also be configured via the connection string parameter "app_telemetry_backoff" in milliseconds.

Declaration

[InterfaceStability(Level.Volatile)]
public TimeSpan Backoff { get; set; }

Property Value

Type	Description
TimeSpan

Enabled

Enables/Disables AppTelemetry. Enabled by default.

Declaration

[InterfaceStability(Level.Volatile)]
public bool Enabled { get; set; }

Property Value

Type	Description
bool

Endpoint

Configures the endpoint where AppTelemetry data should be sent to.

Declaration

[InterfaceStability(Level.Volatile)]
public Uri? Endpoint { get; set; }

Property Value

Type	Description
Uri

PingInterval

Configures the duration between consecutive PING commands sent to the server. The default is 30s. This can also be configured via the connection string parameter "app_telemetry_ping_interval" in milliseconds.

Declaration

[InterfaceStability(Level.Volatile)]
public TimeSpan PingInterval { get; set; }

Property Value

Type	Description
TimeSpan

PingTimeout

Configures the maximum timeout for the server to respond to a PING. The default is 2s. This can also be configured via the connection string parameter "app_telemetry_ping_timeout" in milliseconds.

Declaration

[InterfaceStability(Level.Volatile)]
public TimeSpan PingTimeout { get; set; }

Property Value

Type	Description
TimeSpan