Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SessionMetricCollector

The definition of a session metric collector.

These can be configured to record metric data for a subset of all sessions, specified with a session filter.

Hierarchy

Index

Properties

exportToPrometheus

exportToPrometheus: boolean

Indicates whether the metric collector exports to Prometheus.

groupByProperties

groupByProperties: string[]

list of properties to group by

maximumGroups

maximumGroups: number

Limit on the number of groups maintained by this metric collector.

Session metric collectors can group metrics by property. Topic metric collectors can group metrics by topic type. This property places an upper limit on the number of groups that will be maintained for the metric collector.

For example, if a session metric collector groups by $SessionId and maximumGroups is 10, then metrics will only be collected for the first 10 sessions.

since

6.8

name

name: string

the name of the metric collector

removeMetricsWithNoMatches

removeMetricsWithNoMatches: boolean

Indicates whether metrics with no matches should be removed.

sessionFilter

sessionFilter: string

the session filter