Class ThresholdOptions
Namespace: Couchbase.Core.Diagnostics.Tracing.ThresholdTracing
Assembly: Couchbase.NetClient.dll
Syntax
public class ThresholdOptions : object
Fields
| Improve this Doc View SourceDefaultSampleSize
Declaration
public static readonly int DefaultSampleSize
Field Value
Type | Description |
---|---|
Int32 |
Properties
| Improve this Doc View SourceEmitInterval
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 |
---|---|
Boolean |
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
| Improve this Doc View SourceGetServiceThresholds()
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 |
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 |
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 |
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 |
Returns
Type | Description |
---|---|
ThresholdOptions | A ThresholdOptions for chaining. |
Remarks
The default is 1 second.
WithSampleSize(UInt32)
How many entries to sample per service in each emit interval
Declaration
public ThresholdOptions WithSampleSize(uint sampleSize)
Parameters
Type | Name | Description |
---|---|---|
UInt32 | sampleSize | A |
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 |
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 |
Returns
Type | Description |
---|---|
ThresholdOptions | A ThresholdOptions for chaining. |
Remarks
The default is 1 second.