Class NodeMetrics

The snapshot of current sampled health metrics for any monitored process. Collected and gossipped at regular intervals for dynamic cluster management strategies.

Equality of NodeMetrics is based on its address.

Inheritance
Object
NodeMetrics
Implements
Inherited Members
Namespace: Akka.Cluster.Metrics.Serialization
Assembly: Akka.Cluster.Metrics.dll
Syntax
public sealed class NodeMetrics : IEquatable<NodeMetrics>

Constructors

| Improve this Doc View Source

NodeMetrics(Address, Int64, IEnumerable<NodeMetrics.Types.Metric>)

Creates new instance of NodeMetrics

Declaration
public NodeMetrics(Address address, long timestamp, IEnumerable<NodeMetrics.Types.Metric> metrics)
Parameters
Type Name Description
Address address

Address of the node the metrics are gathered at
Int64 timestamp

the time of sampling, in milliseconds since midnight, January 1, 1970 UTC
IEnumerable<NodeMetrics.Types.Metric> metrics

The set of sampled NodeMetrics.Types.Metric

Properties

| Improve this Doc View Source

Address

Declaration
public Address Address { get; }
Property Value
Type Description
Address
| Improve this Doc View Source

Metrics

Declaration
public ImmutableHashSet<NodeMetrics.Types.Metric> Metrics { get; }
Property Value
Type Description
System.Collections.Immutable.ImmutableHashSet<NodeMetrics.Types.Metric>
| Improve this Doc View Source

Timestamp

Declaration
public long Timestamp { get; }
Property Value
Type Description
Int64

Methods

| Improve this Doc View Source

Equals(NodeMetrics)

Declaration
public bool Equals(NodeMetrics other)
Parameters
Type Name Description
NodeMetrics other
Returns
Type Description
Boolean
| Improve this Doc View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
Overrides
| Improve this Doc View Source

Merge(NodeMetrics)

Returns the most recent data.

Declaration
public NodeMetrics Merge(NodeMetrics that)
Parameters
Type Name Description
NodeMetrics that
Returns
Type Description
NodeMetrics
| Improve this Doc View Source

Metric(String)

Gets metric by key

Declaration
public Option<NodeMetrics.Types.Metric> Metric(string name)
Parameters
Type Name Description
String name
Returns
Type Description
Option<NodeMetrics.Types.Metric>
| Improve this Doc View Source

SameAs(NodeMetrics)

Returns true if 

that
address is the same as this

Declaration
public bool SameAs(NodeMetrics that)
Parameters
Type Name Description
NodeMetrics that
Returns
Type Description
Boolean
| Improve this Doc View Source

Update(NodeMetrics)

Returns the most recent data with NodeMetrics.Types.EWMA averaging.

Declaration
public NodeMetrics Update(NodeMetrics that)
Parameters
Type Name Description
NodeMetrics that
Returns
Type Description
NodeMetrics

Implements

Extension Methods