Class MetricPlan

Namespace

Typhon.Protocol

Assembly

Typhon.Protocol.dll

A metric compiled: its codec and how many values it contributes to its STATS segment.

public sealed class MetricPlan

Inheritance

object

MetricPlan

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

Idx

The wire index.

public int Idx { get; }

Property Value

int

Metric

The catalog metric.

public CatalogMetric Metric { get; }

Property Value

CatalogMetric

Name

The metric name.

public string Name { get; }

Property Value

string

Offset

Its position within its own segment — ServerMetrics or SessionMetrics, whichever Session names. Not Idx: the wire indices interleave the two scopes and skip the built-ins a runtime does not publish.

public int Offset { get; }

Property Value

int

Remarks

Assigned when the plan is compiled, because the alternative is what it replaced: a sink handed a MetricPlan per VALUE had to recover its array with Array.IndexOf, which is a linear scan per sample and therefore quadratic in the metric count — on the one block whose whole purpose is to grow that count.

Session

Whether it belongs to the per-session segment.

public bool Session { get; }

Property Value

bool

Value

The codec of each value.

public FieldPlan Value { get; }

Property Value

FieldPlan

ValueCount

Values per emission: its label count, or 1 for a scalar.

public int ValueCount { get; }

Property Value

int