public static interface Metrics.SessionMetricCollector.Builder
A builder of this type may be created using
newSessionMetricCollectorBuilder
and used to create instances of
Metrics.SessionMetricCollector
that can be supplied to
putSessionMetricCollector
.
Modifier and Type | Method and Description |
---|---|
Metrics.SessionMetricCollector |
create(String name,
String sessionFilter)
Create a new
Metrics.SessionMetricCollector using the values
currently known to this builder. |
Metrics.SessionMetricCollector.Builder |
exportToPrometheus(boolean export)
Specifies whether the metric collector should export metrics to
Prometheus or not.
|
Metrics.SessionMetricCollector.Builder |
groupByProperties(List<String> propertyNames)
Specifies a list of session property names to group by, replacing
any current list known to this builder.
|
Metrics.SessionMetricCollector.Builder |
groupByProperty(String propertyName)
Adds the name of a session property to group by to the list known
to this builder.
|
Metrics.SessionMetricCollector.Builder |
removeMetricsWithNoMatches(boolean remove)
Specifies whether the metric collector should remove any metrics
that have no matches.
|
Metrics.SessionMetricCollector.Builder |
reset()
Reset the builder.
|
Metrics.SessionMetricCollector.Builder exportToPrometheus(boolean export)
The default is that metrics are not exported to Prometheus.
export
- true to export metrics to PrometheusMetrics.SessionMetricCollector.Builder groupByProperty(String propertyName)
By default a builder will initially have no session properties to group by set.
propertyName
- the name of the session property. See
Session
for details of session propertiesMetrics.SessionMetricCollector.Builder groupByProperties(List<String> propertyNames)
propertyNames
- a list of session property names. See
Session
for details of session propertiesMetrics.SessionMetricCollector.Builder removeMetricsWithNoMatches(boolean remove)
The default is that the metric collector will not remove metrics with no matches.
remove
- true to indicate that metrics with no matches
should be removedMetrics.SessionMetricCollector.Builder reset()
Metrics.SessionMetricCollector create(String name, String sessionFilter)
Metrics.SessionMetricCollector
using the values
currently known to this builder.name
- the name of the Metrics.SessionMetricCollector
sessionFilter
- the session filter indicating the sessions
this collector should apply to. The format of a session
property filter is documented in Session
Metrics.SessionMetricCollector
with all of the
current settings of this builderCopyright © 2021 Push Technology Ltd. All Rights Reserved.