Class OrphanOptions

Inheritance

object

OrphanOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Couchbase.Core.Diagnostics.Tracing.OrphanResponseReporting

Assembly: Couchbase.NetClient.dll

Syntax

public sealed class OrphanOptions

Properties

EmitInterval

The interval after which the aggregated information is logged.

Declaration

public TimeSpan EmitInterval { get; set; }

Property Value

Type	Description
TimeSpan

Enabled

Enables orphaned response tracing. Defaults to enabled.

Declaration

public bool Enabled { get; set; }

Property Value

Type	Description
bool

OrphanListener

Provides the means of registering a custom TraceListener implementation.

Declaration

public TraceListener OrphanListener { get; set; }

Property Value

Type	Description
TraceListener

Remarks

It is suggested that the default OrphanListener be used instead of a custom implementation.

SampleSize

How many entries to sample per service in each emit interval.

Declaration

public uint SampleSize { get; set; }

Property Value

Type	Description
uint

Methods

WithEmitInterval(TimeSpan)

The interval after which the aggregated information is logged.

Declaration

public OrphanOptions WithEmitInterval(TimeSpan emitInterval)

Parameters

Type	Name	Description
TimeSpan	emitInterval	A TimeSpan which is the interval.

Returns

Type	Description
OrphanOptions	A OrphanOptions object for chaining.

WithEnabled(bool)

Enables orphaned response tracing.

Declaration

public OrphanOptions WithEnabled(bool enabled)

Parameters

Type	Name	Description
bool	enabled	A bool true if enabled.

Returns

Type	Description
OrphanOptions	A OrphanOptions object for chaining.

Remarks

Default is true.

WithSampleSize(uint)

How many entries to sample per service in each emit interval.

Declaration

public OrphanOptions WithSampleSize(uint sampleSize)

Parameters

Type	Name	Description
uint	sampleSize	A uint which is the sample size to emit.

Returns

Type	Description
OrphanOptions