Table of Contents

Class MetricDeclaration

Namespace
Typhon.Engine
Assembly
Typhon.Engine.dll

An application metric and where its value comes from.

public sealed class MetricDeclaration
Inheritance
MetricDeclaration
Inherited Members

Properties

Codec

How the value travels.

public Codec Codec { get; }

Property Value

Codec

Index

The order this metric was declared in. Not the wire index, which starts above the engine's reserved range.

public int Index { get; }

Property Value

int

Kind

Gauge or counter.

public MetricKind Kind { get; }

Property Value

MetricKind

Labels

The labels, empty when the metric contributes one value.

public IReadOnlyList<string> Labels { get; }

Property Value

IReadOnlyList<string>

Name

The metric's name.

public string Name { get; }

Property Value

string

PerSession

Whether the metric has a value per session rather than one for the server.

public bool PerSession { get; }

Property Value

bool

SessionSource

A per-session metric's reader; null for a server-scope one.

public Func<SessionId, double> SessionSource { get; }

Property Value

Func<SessionId, double>

Unit

Its unit.

public string Unit { get; }

Property Value

string

ValuesSource

A labelled metric's reader, which fills one value per label; null for the other shapes.

public MetricValuesSource ValuesSource { get; }

Property Value

MetricValuesSource

Methods

ToString()

public override string ToString()

Returns

string