Class ThresholdOptions

Inheritance

object

ThresholdOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Couchbase.Core.Diagnostics.Tracing.ThresholdTracing

Assembly: Couchbase.NetClient.dll

Syntax

public class ThresholdOptions

Constructors

ThresholdOptions()

Declaration

public ThresholdOptions()

Fields

DefaultSampleSize

Declaration

public static readonly int DefaultSampleSize

Field Value

Type	Description
int

Properties

EmitInterval

Declaration

public TimeSpan EmitInterval { get; set; }

Property Value

Type	Description
TimeSpan

Enabled

Enables threshold tracing. Defaults to enabled.

Declaration

public bool Enabled { get; set; }

Property Value

Type	Description
bool

ThresholdListener

Provides the means of registering a custom TraceListener implementation.

Declaration

public TraceListener ThresholdListener { get; set; }

Property Value

Type	Description
TraceListener

Remarks

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

Methods

GetServiceThresholds()

Declaration

public IReadOnlyDictionary<string, TimeSpan> GetServiceThresholds()

Returns

Type	Description
IReadOnlyDictionary<string, TimeSpan>

WithAnalyticsThreshold(TimeSpan)

The threshold over which the request is taken into account for the search service

Declaration

public ThresholdOptions WithAnalyticsThreshold(TimeSpan analyticsThreshold)

Parameters

Type	Name	Description
TimeSpan	analyticsThreshold	A TimeSpan interval.

Returns

Type	Description
ThresholdOptions	A ThresholdOptions for chaining.

Remarks

The default is 1 second.

WithEmitInterval(TimeSpan)

The interval after which the aggregated trace information is logged.

Declaration

public ThresholdOptions WithEmitInterval(TimeSpan emitInterval)

Parameters

Type	Name	Description
TimeSpan	emitInterval	A TimeSpan interval.

Returns

Type	Description
ThresholdOptions	A ThresholdOptions for chaining.

Remarks

The default is 10 seconds.

WithKvThreshold(TimeSpan)

The interval after which the aggregated trace information is logged.

Declaration

public ThresholdOptions WithKvThreshold(TimeSpan kvThreshold)

Parameters

Type	Name	Description
TimeSpan	kvThreshold	A TimeSpan interval.

Returns

Type	Description
ThresholdOptions	A ThresholdOptions for chaining.

Remarks

The default is 500 Milliseconds.

WithQueryThreshold(TimeSpan)

The threshold over which the request is taken into account for the query service

Declaration

public ThresholdOptions WithQueryThreshold(TimeSpan queryThreshold)

Parameters

Type	Name	Description
TimeSpan	queryThreshold	A TimeSpan interval.

Returns

Type	Description
ThresholdOptions	A ThresholdOptions for chaining.

Remarks

The default is 1 second.

WithSampleSize(uint)

How many entries to sample per service in each emit interval

Declaration

public ThresholdOptions WithSampleSize(uint sampleSize)

Parameters

Type	Name	Description
uint	sampleSize	A uint indicating the sample size.

Returns

Type	Description
ThresholdOptions	A ThresholdOptions for chaining.

Remarks

The default is 10 samples.

WithSearchThreshold(TimeSpan)

The threshold over which the request is taken into account for the search service

Declaration

public ThresholdOptions WithSearchThreshold(TimeSpan searchThreshold)

Parameters

Type	Name	Description
TimeSpan	searchThreshold	A TimeSpan interval.

Returns

Type	Description
ThresholdOptions	A ThresholdOptions for chaining.

Remarks

The default is 1 second.

WithViewsThreshold(TimeSpan)

The threshold over which the request is taken into account for the views service

Declaration

public ThresholdOptions WithViewsThreshold(TimeSpan viewsThreshold)

Parameters

Type	Name	Description
TimeSpan	viewsThreshold	A TimeSpan interval.

Returns

Type	Description
ThresholdOptions	A ThresholdOptions for chaining.

Remarks

The default is 1 second.