Interface IHistogram

Basic histogram interface to be implemented by all types of instrumentation histograms

Inherited Members
System.Collections.Generic.IEnumerable<NFX.Instrumentation.Analytics.HistogramEntry>.GetEnumerator()
Namespace: NFX.Instrumentation.Analytics
Assembly: NFX.dll
Syntax
public interface IHistogram : IEnumerable<HistogramEntry>, IEnumerable

Properties

DimensionCount

Number of dimensions in this histogram

Declaration
int DimensionCount { get; }
Property Value
Type Description
System.Int32

Dimensions

Returns the dimension instances of this histogram

Declaration
IEnumerable<Dimension> Dimensions { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<Dimension>

Item[HistogramKeys]

Return the count of samples for the given histogram keys

Declaration
int this[HistogramKeys keys] { get; }
Parameters
Type Name Description
HistogramKeys keys
Property Value
Type Description
System.Int32

Title

Histogram title used for displaying purposes

Declaration
string Title { get; }
Property Value
Type Description
System.String

TotalSamples

Total number of samples in the histogram

Declaration
long TotalSamples { get; }
Property Value
Type Description
System.Int64

Methods

Clear()

Reset histogram state

Declaration
void Clear()

GetDimention(Int32)

Return a dimension of a histogram identified by index

Declaration
Dimension GetDimention(int dimension)
Parameters
Type Name Description
System.Int32 dimension
Returns
Type Description
Dimension

GetPartitionName(Int32, Int32)

Returns the name of a partition in a given histogram dimension

Declaration
string GetPartitionName(int dimension, int partition)
Parameters
Type Name Description
System.Int32 dimension

Dimension index
System.Int32 partition

Partition index
Returns
Type Description
System.String

TryGet(HistogramKeys, out Int32)

Try to get the count of samples for the given histogram keys

Declaration
bool TryGet(HistogramKeys keys, out int count)
Parameters
Type Name Description
HistogramKeys keys
System.Int32 count
Returns
Type Description
System.Boolean

Extension Methods