Interface IDriverMetrics

Exposes driver metrics.

Namespace: Dse.Metrics
Assembly: Dse.dll
Syntax
public interface IDriverMetrics

Properties

NodeMetrics

Exposes node metrics for the hosts used in requests executed by the session from which this instance was retrieved. See GetMetrics().

Declaration
IReadOnlyDictionary<Host, IMetricsRegistry<NodeMetric>> NodeMetrics { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyDictionary<Host, IMetricsRegistry<NodeMetric>>

SessionMetrics

Exposes session metrics for the session from which this instance was retrieved. See GetMetrics().

Declaration
IMetricsRegistry<SessionMetric> SessionMetrics { get; }
Property Value
Type Description
IMetricsRegistry<SessionMetric>

Methods

GetNodeMetric<TMetricType>(Host, NodeMetric)

Gets a specific node metric of a specific host. TMetricType can be any type in the inheritance tree of the metric object returned by the IDriverMetricsProvider.

Declaration
TMetricType GetNodeMetric<TMetricType>(Host host, NodeMetric nodeMetric)

    where TMetricType : class, IDriverMetric
Parameters
Type Name Description
Host host
NodeMetric nodeMetric
Returns
Type Description
TMetricType
Type Parameters
Name Description
TMetricType
Exceptions
Type Condition
System.ArgumentException

This exception is thrown if the metric object can not be cast to TMetricType.

GetSessionMetric<TMetricType>(SessionMetric)

Gets a specific session metric. TMetricType can be any type in the inheritance tree of the metric object returned by the IDriverMetricsProvider.

Declaration
TMetricType GetSessionMetric<TMetricType>(SessionMetric sessionMetric)

    where TMetricType : class, IDriverMetric
Parameters
Type Name Description
SessionMetric sessionMetric
Returns
Type Description
TMetricType
Type Parameters
Name Description
TMetricType
Exceptions
Type Condition
System.ArgumentException

This exception is thrown if the metric object can not be cast to TMetricType.

Extension Methods