Create and manage topic metrics.

Functions
void	diffusion_topic_metric_collector_free (DIFFUSION_TOPIC_METRIC_COLLECTOR_T *collector)
	Free a topic metric collector.
bool	diffusion_topic_metric_collector_get_topic_selector (DIFFUSION_TOPIC_METRIC_COLLECTOR_T *collector, char **topic_selector)
	Returns the topic selector of the topic metric collector.
bool	diffusion_topic_metric_collector_get_name (DIFFUSION_TOPIC_METRIC_COLLECTOR_T *collector, char **name)
	Returns the name of the topic metric collector.
bool	diffusion_topic_metric_collector_groups_by_topic_type (DIFFUSION_TOPIC_METRIC_COLLECTOR_T *collector, bool *groups_by_topic_type)
	Specifies whether the metric collector should group by topic type.
bool	diffusion_topic_metric_collector_groups_by_topic_view (DIFFUSION_TOPIC_METRIC_COLLECTOR_T *collector, bool *groups_by_topic_view)
	Indicates whether the metric collector groups by topic view.
bool	diffusion_topic_metric_collector_group_by_path_prefix_parts (DIFFUSION_TOPIC_METRIC_COLLECTOR_T *collector, int *group_by_path_prefix_parts)
	Specifies the number of leading parts of the topic path to group by, or 0, if the collector does not group by path prefix.
bool	diffusion_topic_metric_collector_exports_to_prometheus (DIFFUSION_TOPIC_METRIC_COLLECTOR_T *collector, bool *exports_to_prometheus)
	Indicates whether the metric collector exports to Prometheus.
bool	diffusion_topic_metric_collector_maximum_groups (DIFFUSION_TOPIC_METRIC_COLLECTOR_T *collector, int *maximum_groups)
	Limit the number of groups maintained by this metric collector.
bool	diffusion_topic_metric_collector_compare (DIFFUSION_TOPIC_METRIC_COLLECTOR_T *collector_1, DIFFUSION_TOPIC_METRIC_COLLECTOR_T *collector_2)
	Compares two topic metric collectors.

Detailed Description

Function Documentation

diffusion_topic_metric_collector_compare()

bool diffusion_topic_metric_collector_compare	(	DIFFUSION_TOPIC_METRIC_COLLECTOR_T *	collector_1,
		DIFFUSION_TOPIC_METRIC_COLLECTOR_T *	collector_2 )

Compares two topic metric collectors.

Parameters

collector_1	a topic metric collector
collector_2	another topic metric collector

Returns

true if both topic metric collectors are identical.

Since

6.7

diffusion_topic_metric_collector_exports_to_prometheus()

bool diffusion_topic_metric_collector_exports_to_prometheus	(	DIFFUSION_TOPIC_METRIC_COLLECTOR_T *	collector,
		bool *	exports_to_prometheus )

Indicates whether the metric collector exports to Prometheus.

Parameters

collector	the topic metric collector
exports_to_prometheus	the variable that will receive the bool value if present

Returns

true if the collector is valid and extracted the value

Since

6.7

diffusion_topic_metric_collector_free()

void diffusion_topic_metric_collector_free

(

DIFFUSION_TOPIC_METRIC_COLLECTOR_T *

collector

)

Free a topic metric collector.

Parameters

collector

the topic metric collector

Since

6.7

diffusion_topic_metric_collector_get_name()

bool diffusion_topic_metric_collector_get_name	(	DIFFUSION_TOPIC_METRIC_COLLECTOR_T *	collector,
		char **	name )

Returns the name of the topic metric collector.

Parameters

collector	the topic metric collector
name	the variable that will receive the name if present

Returns

true if the collector is valid and extracted the value

Since

6.7

diffusion_topic_metric_collector_get_topic_selector()

bool diffusion_topic_metric_collector_get_topic_selector	(	DIFFUSION_TOPIC_METRIC_COLLECTOR_T *	collector,
		char **	topic_selector )

Returns the topic selector of the topic metric collector.

Parameters

collector	the topic metric collector
topic_selector	the variable that will receive the topic selector if present

Returns

true if the collector is valid and extracted the value

Since

6.7

diffusion_topic_metric_collector_group_by_path_prefix_parts()

bool diffusion_topic_metric_collector_group_by_path_prefix_parts	(	DIFFUSION_TOPIC_METRIC_COLLECTOR_T *	collector,
		int *	group_by_path_prefix_parts )

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

Parameters

collector	the topic metric collector
group_by_path_prefix_parts	the variable that will receive the int value if present

Returns

true if the collector is valid and extracted the value

Since

6.8

diffusion_topic_metric_collector_groups_by_topic_type()

bool diffusion_topic_metric_collector_groups_by_topic_type	(	DIFFUSION_TOPIC_METRIC_COLLECTOR_T *	collector,
		bool *	groups_by_topic_type )

Specifies whether the metric collector should group by topic type.

Parameters

collector	the topic metric collector
groups_by_topic_type	the variable that will receive the bool value if present

Returns

true if the collector is valid and extracted the value

Since

6.7

diffusion_topic_metric_collector_groups_by_topic_view()

bool diffusion_topic_metric_collector_groups_by_topic_view	(	DIFFUSION_TOPIC_METRIC_COLLECTOR_T *	collector,
		bool *	groups_by_topic_view )

Indicates whether the metric collector groups by topic view.

Parameters

collector	the topic metric collector
groups_by_topic_view	the variable that will receive the bool value if present

Returns

true if the collector is valid and extracted the value

Since

6.9

diffusion_topic_metric_collector_maximum_groups()

bool diffusion_topic_metric_collector_maximum_groups	(	DIFFUSION_TOPIC_METRIC_COLLECTOR_T *	collector,
		int *	maximum_groups )

Limit the number of groups maintained by this metric collector.

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

Parameters

collector	the topic metric collector
maximum_groups	the variable that will receive the int value if present

Returns

true if the collector is valid and extracted the value

Since

6.8