Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SessionMetricCollectorBuilder

A session metric collector builder.

A builder of this type may be created using newSessionMetricCollectorBuilder and used to create instances of SessionMetricCollector that can be supplied to putSessionMetricCollector.

Hierarchy

  • SessionMetricCollectorBuilder

Index

Methods

create

exportToPrometheus

  • Specifies whether the metric collector should export metrics to Prometheus or not.

    The default is that metrics are not exported to Prometheus.

    Parameters

    • exportMetrics: boolean

    Returns SessionMetricCollectorBuilder

    this builder

groupByProperties

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

    throws

    a NullValueError if propertyNames is null or undefined

    Parameters

    • propertyNames: string[]

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

    Returns SessionMetricCollectorBuilder

    this builder

groupByProperty

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

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

    throws

    a NullValueError if the propertyName is null or undefined

    Parameters

    • propertyName: string

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

    Returns SessionMetricCollectorBuilder

    this builder

maximumGroups

removeMetricsWithNoMatches

  • 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: boolean

      true to indicate that metrics with no matches should be removed

    Returns SessionMetricCollectorBuilder

    this builder

reset