A session metric collector builder. More...

#include <PTDiffusionSessionMetricCollectorBuilder.h>

Inheritance diagram for PTDiffusionSessionMetricCollectorBuilder:

Instance Methods
(instancetype)	- groupByProperty:
(instancetype)	- groupByProperties:
(instancetype)	- removeMetricsWithNoMatches:
(PTDiffusionSessionMetricCollector *)	- createCollectorWithName:andSessionFilter:
	Create a new `PTDiffusionSessionMetricCollector` using the values currently known to this builder.
Instance Methods inherited from PTDiffusionMetricCollectorBuilder
(instancetype)	- reset
	Resets the builder.
(instancetype)	- exportToPrometheus:
	Specifies whether the metric collector should export metrics to Prometheus or not.
(instancetype)	- maximumGroups:
	Set the maximum number of groups maintained by the metric collector.

Detailed Description

A session metric collector builder.

Method Documentation

- (PTDiffusionSessionMetricCollector *) createCollectorWithName:		(NSString *const)	name
andSessionFilter:		(NSString *const)	sessionFilter

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

Parameters

name	the name of the `PTDiffusionSessionMetricCollector`
sessionFilter	the session filter indicating the sessions this filter should apply to. The format of a session property filter is documented in `PTDiffusionSession`

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

- (instancetype) groupByProperties: (NSArray< NSString * > *) propertyNames

Specifies a list of session property names to group by, replacing any current list known to this builder.

Parameters

propertyNames a list of session property names. See Session for details of session properties.

- (instancetype) groupByProperty: (NSString *) propertyName

Adds the name of a session property to group by to the list known to this builder.

Parameters

propertyName the name of the session property. See Session for details of session properties.

- (instancetype) removeMetricsWithNoMatches: (BOOL) remove

Specifies whether the metric collector should remove any metrics that have no matches.

The default is that the metric collector will not remove metrics with no matches.

Parameters

remove true to indicate that metrics with no matches should be removed.