Interface IMetricCollector

The common base interface for metric collectors.

Namespace: PushTechnology.ClientInterface.Client.Features.Metrics

Assembly: Diffusion.Client.dll

Syntax

public interface IMetricCollector

Properties

ExportsToPrometheus

Indicates whether the metric collector exports to Prometheus.

Declaration

bool ExportsToPrometheus { get; set; }

Property Value

Type	Description
System.Boolean	Whether the metric collector exports to Prometheus.

MaximumGroups

Limits the number of groups maintained by this metric collector. Since 6.8.

Declaration

int MaximumGroups { get; set; }

Property Value

Type	Description
System.Int32	The maximum number of groups maintained by this metric collector.

Remarks

Session metric collectors can group metrics by property GroupByProperties. Topic metric collectors can group metrics by topic type GroupsByTopicType and by topic view GroupsByTopicView. This property places an upper limit on the number of groups that will be maintained for the metric collector.

For example, if a session metric collector groups by

$SessionId

and maximumGroups is 10, then metrics will only be collected for the first 10 sessions.

Name

The name of the metric collector.

Declaration

string Name { get; set; }

Property Value

Type	Description
System.String	The name of the metric collector.