Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TopicMetricCollectorBuilder

A topic metric collector builder.

A builder of this type may be created using newTopicMetricCollectorBuilder and used to create instances of TopicMetricCollector that can be supplied to putTopicMetricCollector.

Hierarchy

  • TopicMetricCollectorBuilder

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 TopicMetricCollectorBuilder

    this builder

groupByPathPrefixParts

  • Specifies the number of leading parts of the topic path the metric collector should use to group results.

    By default a topic metric collector does not group by the topic path prefix. If a positive number of parts is specified, it will enable grouping.

    since

    6.8

    Parameters

    • parts: number

      the number of leading parts of the topic path to group by; set to 0 to disable grouping by path

    Returns TopicMetricCollectorBuilder

    this builder

groupByTopicType

  • Specifies whether the metric collector should group by topic type.

    By default a topic metric collector does not group by topic type.

    Parameters

    • groupByTopicType: boolean

      true to indicate that the collector should group by topic type

    Returns TopicMetricCollectorBuilder

    this builder

groupByTopicView

  • Specifies whether the metric collector should group by topic view.

    By default a topic metric collector does not group by topic view.

    Parameters

    • groupByTopicView: boolean

      true to indicate that the collector should group by topic view.

    Returns TopicMetricCollectorBuilder

    this builder.

maximumGroups

reset