Interface ISessionMetricCollectorBuilder

Namespace

PushTechnology.ClientInterface.Client.Features.Metrics

Assembly

Diffusion.Client.dll

A session metric collector builder.

public interface ISessionMetricCollectorBuilder : IMetricCollectorBuilder

Inherited Members

IMetricCollectorBuilder.ExportsToPrometheus(bool)

IMetricCollectorBuilder.MaximumGroups(int)

IMetricCollectorBuilder.Reset()

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.

ISessionMetricCollector Create(string name, string sessionFilter)

Parameters

name string

The name of the ISessionMetricCollector.

sessionFilter string

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

Returns

ISessionMetricCollector

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

Exceptions

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.

ISessionMetricCollectorBuilder GroupByProperties(List<string> propertyNames)

Parameters

propertyNames List<string>

A list of session property names. See ISession for details of session properties.

Returns

ISessionMetricCollectorBuilder

This builder.

Exceptions

ArgumentNullException

The propertyNames is null.

GroupByProperty(string)

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

ISessionMetricCollectorBuilder GroupByProperty(string propertyName)

Parameters

propertyName string

The name of the session property. See ISession for details of session properties.

Returns

ISessionMetricCollectorBuilder

This builder.

Remarks

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

Exceptions

ArgumentNullException

The propertyName is null.

RemoveMetricsWithNoMatches(bool)

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

ISessionMetricCollectorBuilder RemoveMetricsWithNoMatches(bool remove)

Parameters

remove bool

True to indicate that metrics with no matches should be removed

Returns

ISessionMetricCollectorBuilder

This builder.

Remarks

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