Introduction

A topic metric collector builder.

Inheritance diagram for PTDiffusionTopicMetricCollectorBuilder:

Instance Methods
(instancetype)	- groupByTopicType:

(instancetype)	- groupByTopicView:

(instancetype)	- groupByPathPrefixParts:

(PTDiffusionTopicMetricCollector *)	- createCollectorWithName:andTopicSelector:
	Create a new PTDiffusionTopicMetricCollector using the values currently known to this builder. More...

Instance Methods inherited from PTDiffusionMetricCollectorBuilder
(instancetype)	- reset
	Resets the builder. More...

(instancetype)	- exportToPrometheus:
	Specifies whether the metric collector should export metrics to Prometheus or not. More...

(instancetype)	- maximumGroups:
	Set the maximum number of groups maintained by the metric collector. More...

Method Documentation

- (PTDiffusionTopicMetricCollector *) createCollectorWithName:	(NSString *const)	name
andTopicSelector:	(NSString *const)	topicSelector

Create a new PTDiffusionTopicMetricCollector using the values currently known to this builder.

Parameters

name	the name of the PTDiffusionTopicMetricCollector
topicSelector	the selector pattern that specifies the topics for which metrics are to be collected.

Returns: a new PTDiffusionTopicMetricCollector with all of the current settings of this builder.

- (instancetype) groupByPathPrefixParts: (NSInteger) parts

Specified the number of leading parts of the topic path the metric collector should use to group results.

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.

Parameters

parts the number of leading parts of the topic path to group by; set to 0 to disable grouping by path

- (instancetype) groupByTopicType: (BOOL) groupByTopicType

Specifies whether the metric collector should group by topic type.

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

Parameters

groupByTopicType true to indicate that the collector should group by topic type

- (instancetype) groupByTopicView: (BOOL) groupByTopicView

Specifies whether the metric collector should group by topic view.

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

Parameters

groupByTopicView true to indicate that the collector should group by topic view