Expand Collapse
Just a second...

MetricCollectors

Metric collectors.

Object name format

The objectName for MBeans of this type is of the following form: com.pushtechnology.diffusion:type=MetricCollectors,server="server_name"

Attributes

Name Type Read/Write Description
sessionMetricCollectors List read The session metric collectors.
topicMetricCollectors List read The topic metric collectors.

Operations

Name Return Type Arguments Impact Description
putSessionMetricCollector void 5 ACTION Add a session metric collector, replacing any with the same name.
Argument name Type Description
name String Metric collector name.
exportToPrometheus boolean Whether the metric collector should be exposed through the Prometheus gateway.
maximumGroups int The maximum number of groups maintained by the metric collector.
removeMetricsWithNoMatches boolean Whether metrics should be removed when there are no matching sessions.
sessionFilter String Session filter used to select the sessions to collect.
Name Return Type Arguments Impact Description
putSessionMetricCollector void 6 ACTION Add a session metric collector, replacing any with the same name.
Argument name Type Description
name String Metric collector name.
exportToPrometheus boolean Whether the metric collector should be exposed through the Prometheus gateway.
maximumGroups int The maximum number of groups maintained by the metric collector.
removeMetricsWithNoMatches boolean Whether metrics should be removed when there are no matching sessions.
sessionFilter String Session filter used to select the sessions to collect.
groupByProperty String Session property used to partition the collected metrics.
Name Return Type Arguments Impact Description
putSessionMetricCollector void 7 ACTION Add a session metric collector, replacing any with the same name.
Argument name Type Description
name String Metric collector name.
exportToPrometheus boolean Whether the metric collector should be exposed through the Prometheus gateway.
maximumGroups int The maximum number of groups maintained by the metric collector.
removeMetricsWithNoMatches boolean Whether metrics should be removed when there are no matching sessions.
sessionFilter String Session filter used to select the sessions to collect.
groupByProperty String Session property used to partition the results.
groupByProperty2 String Session property used to further partition the results.
Name Return Type Arguments Impact Description
putTopicMetricCollector void 7 ACTION Add a topic metric collector, replacing any with the same name.
Argument name Type Description
name String Metric collector name.
exportToPrometheus boolean Whether the metric collector should be exposed through the Prometheus gateway.
maximumGroups int The maximum number of groups maintained by the metric collector.
topicSelector String Topic selector used to select the topics to collect.
groupByTopicType boolean Whether the collected metrics should be partitioned by topic type.
groupByTopicView boolean Whether the collected metrics should be partitioned by topic view.
groupByPathPrefixParts int The number of leading parts of the topic path to group by.
Name Return Type Arguments Impact Description
removeSessionCollector void 1 ACTION Remove the sesion metric collector with the given name.
Argument name Type Description
name String Metric collector name.
Name Return Type Arguments Impact Description
removeTopicCollector void 1 ACTION Remove the topic metric collector with the given name.
Argument name Type Description
name String Metric collector name.
Name Return Type Arguments Impact Description
putSessionMetricCollector void 4 ACTION Add a session metric collector, replacing any with the same name.
Argument name Type Description
name String Metric collector name.
exportToPrometheus boolean Whether the metric collector should be exposed through the Prometheus gateway.
removeMetricsWithNoMatches boolean Whether metrics should be removed when there are no matching sessions.
sessionFilter String Session filter used to select the sessions to collect.
Name Return Type Arguments Impact Description
putSessionMetricCollector void 5 ACTION Add a session metric collector, replacing any with the same name.
Argument name Type Description
name String Metric collector name.
exportToPrometheus boolean Whether the metric collector should be exposed through the Prometheus gateway.
removeMetricsWithNoMatches boolean Whether metrics should be removed when there are no matching sessions.
sessionFilter String Session filter used to select the sessions to collect.
groupByProperty String Session property used to partition the collected metrics.
Name Return Type Arguments Impact Description
putSessionMetricCollector void 6 ACTION Add a session metric collector, replacing any with the same name.
Argument name Type Description
name String Metric collector name.
exportToPrometheus boolean Whether the metric collector should be exposed through the Prometheus gateway.
removeMetricsWithNoMatches boolean Whether metrics should be removed when there are no matching sessions.
sessionFilter String Session filter used to select the sessions to collect.
groupByProperty String Session property used to partition the results.
groupByProperty2 String Session property used to further partition the results.
Name Return Type Arguments Impact Description
putTopicMetricCollector void 6 ACTION Add a topic metric collector, replacing any with the same name.
Argument name Type Description
name String Metric collector name.
exportToPrometheus boolean Whether the metric collector should be exposed through the Prometheus gateway.
maximumGroups int The maximum number of groups maintained by the metric collector.
topicSelector String Topic selector used to select the topics to collect.
groupByTopicType boolean Whether the collected metrics should be partitioned by topic type.
groupByPathPrefixParts int The number of leading parts of the topic path to group by.
Name Return Type Arguments Impact Description
putTopicMetricCollector void 4 ACTION Add a topic metric collector, replacing any with the same name.
Argument name Type Description
name String Metric collector name.
exportToPrometheus boolean Whether the metric collector should be exposed through the Prometheus gateway.
topicSelector String Topic selector used to select the topics to collect.
groupByTopicType boolean Whether the collected metrics should be partitioned by topic type.