Click or drag to resize

DriverAppMetricsOptions Class

Options related to the app metrics provider. Currently the existing options are used to configure the HdrHistogram used internally for Timer metrics.
Inheritance Hierarchy
SystemObject
  Dse.AppMetricsDriverAppMetricsOptions

Namespace:  Dse.AppMetrics
Assembly:  Dse.AppMetrics (in Dse.AppMetrics.dll) Version: 1.0.0
Syntax
C#
public class DriverAppMetricsOptions

The DriverAppMetricsOptions type exposes the following members.

Constructors
  NameDescription
Public methodDriverAppMetricsOptions
Initializes a new instance of the DriverAppMetricsOptions class
Top
Properties
  NameDescription
Public propertyHighestLatencyMilliseconds
See SetHighestLatencyMilliseconds(Int32) for information about this property.
Public propertySignificantDigits
See SetSignificantDigits(Int32) for information about this property.
Public propertyTimersTimeUnit
See SetTimersTimeUnit(TimeUnit) for information about this property.
Top
Methods
  NameDescription
Public methodSetHighestLatencyMilliseconds

The largest latency that we expect to record.

This should be slightly higher than ReadTimeoutMillis and WithQueryTimeout(Int32) (in theory, readings can't be higher than the timeout, but there might be a small overhead due to internal scheduling).

This is used to scale internal data structures. If a higher recording is encountered at runtime, it is discarded and a warning is logged.

This property defaults to 30000 milliseconds, i.e., 30 seconds.

Public methodSetSignificantDigits
The number of significant decimal digits to which internal structures will maintain value resolution and separation (for example, 3 means that recordings up to 1 second will be recorded with a resolution of 1 millisecond or better). This must be between 0 and 5. If the value is out of range, an exception is thrown.
Public methodSetTimersTimeUnit
Time unit to use for Timer metrics. This property defaults to Nanoseconds.
Top
See Also