Interface ISessionMetricCollectorBuilder

A session metric collector builder.

Inherited Members
Namespace: PushTechnology.ClientInterface.Client.Features.Metrics
Assembly: Diffusion.Client.dll
Syntax
public interface ISessionMetricCollectorBuilder : IMetricCollectorBuilder
Remarks

A builder of this type may be created using NewSessionMetricCollectorBuilder() and used to create instances of ISessionMetricCollector that can be supplied to PutSessionMetricCollectorAsync(ISessionMetricCollector).

Methods

Create(String, String)

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

Declaration
ISessionMetricCollector Create(string name, string sessionFilter)
Parameters
Type Name Description
System.String name

The name of the ISessionMetricCollector.
System.String sessionFilter

The session filter indicating the sessions this collector should apply to. The format of a session property filter is documented in ISession.
Returns
Type Description
ISessionMetricCollector

A new ISessionMetricCollector with all of the current settings of this builder.
Exceptions
Type Condition
System.ArgumentNullException

The name or sessionFilter is null.

GroupByProperties(List<String>)

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

Declaration
ISessionMetricCollectorBuilder GroupByProperties(List<string> propertyNames)
Parameters
Type Name Description
System.Collections.Generic.List<System.String> propertyNames

A list of session property names. See ISession for details of session properties.
Returns
Type Description
ISessionMetricCollectorBuilder

This builder.
Exceptions
Type Condition
System.ArgumentNullException

The propertyNames is null.

GroupByProperty(String)

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

Declaration
ISessionMetricCollectorBuilder GroupByProperty(string propertyName)
Parameters
Type Name Description
System.String propertyName

The name of the session property. See ISession for details of session properties.
Returns
Type Description
ISessionMetricCollectorBuilder

This builder.
Remarks

By default a builder will initially have no session properties to group by set.

Exceptions
Type Condition
System.ArgumentNullException

The propertyName is null.

RemoveMetricsWithNoMatches(Boolean)

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

Declaration
ISessionMetricCollectorBuilder RemoveMetricsWithNoMatches(bool remove)
Parameters
Type Name Description
System.Boolean remove

True to indicate that metrics with no matches should be removed
Returns
Type Description
ISessionMetricCollectorBuilder

This builder.
Remarks

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