Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TopicMetricCollector

The definition of a topic metric collector.

These can be configured to record metric data for a subset of all topics, specified with a topic selector.

Hierarchy

Index

Properties

exportToPrometheus

exportToPrometheus: boolean

Indicates whether the metric collector exports to Prometheus.

groupByPathPrefixParts

groupByPathPrefixParts: number

The number of leading parts of the topic path to group by, or 0 if the collector does not group by path prefix

since

6.8

groupByTopicType

groupByTopicType: boolean

Indicates whether the collector groups by topic type.

groupByTopicView

groupByTopicView: boolean

Indicates whether the collector groups by topic view.

since

6.9

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

topicSelector

topicSelector: string

the topic selector