Interface ITopicMetricCollectorBuilder

Namespace

PushTechnology.ClientInterface.Client.Features.Metrics

Assembly

Diffusion.Client.dll

A topic metric collector builder.

public interface ITopicMetricCollectorBuilder : IMetricCollectorBuilder

Inherited Members

IMetricCollectorBuilder.ExportsToPrometheus(bool)

IMetricCollectorBuilder.MaximumGroups(int)

IMetricCollectorBuilder.Reset()

Remarks

A builder of this type may be created using NewTopicMetricCollectorBuilder() and used to create instances of ITopicMetricCollector that can be supplied to PutTopicMetricCollectorAsync(ITopicMetricCollector).

Methods

Create(string, string)

Creates a new ITopicMetricCollector using the values currently known to this builder.

ITopicMetricCollector Create(string name, string topicSelector)

Parameters

name string

The name of the ITopicMetricCollector.

topicSelector string

The selector pattern that specifies the topics for which metrics are to be collected.

Returns

ITopicMetricCollector

A new ITopicMetricCollector with all of the current settings of this builder.

Exceptions

ArgumentNullException

The name or topicSelector is null.

TopicSelectorFormatException

The topicSelector is invalid.

ArgumentException

If this builder has been configured using GroupByPathPrefixParts(int) and a negative number of parts.

GroupByPathPrefixParts(int)

Specifies the number of leading parts of the topic path the metric collector should use to group results. Since 6.8.

ITopicMetricCollectorBuilder GroupByPathPrefixParts(int parts)

Parameters

parts int

The number of leading parts of the topic path to group by. Set to 0 to disable grouping by path.

Returns

ITopicMetricCollectorBuilder

This builder.

Remarks

By default a topic metric collector does not group by the topic path prefix. If a positive number of parts is specified, it will enable grouping.

GroupByTopicType(bool)

Specifies whether the metric collector should group by topic type.

ITopicMetricCollectorBuilder GroupByTopicType(bool groupByTopicType)

Parameters

groupByTopicType bool

True to indicate that the collector should group by topic type.

Returns

ITopicMetricCollectorBuilder

This builder.

Remarks

By default a topic metric collector does not group by topic type.

GroupByTopicView(bool)

Specifies whether the metric collector should group by topic view. Since 6.9.

ITopicMetricCollectorBuilder GroupByTopicView(bool groupByTopicView)

Parameters

groupByTopicView bool

True to indicate that the collector should group by topic view.

Returns

ITopicMetricCollectorBuilder

This builder.

Remarks

By default a topic metric collector does not group by topic view.