Create and manage session metrics.

Functions
void	diffusion_session_metric_collector_free (DIFFUSION_SESSION_METRIC_COLLECTOR_T *collector)
	Free a session metric collector.
bool	diffusion_session_metric_collector_get_session_filter (DIFFUSION_SESSION_METRIC_COLLECTOR_T *collector, char **session_filter)
	Returns the session filter of the session metric collector.
bool	diffusion_session_metric_collector_get_name (DIFFUSION_SESSION_METRIC_COLLECTOR_T *collector, char **name)
	Returns the name of the session metric collector.
bool	diffusion_session_metric_collector_removes_metrics_with_no_matches (DIFFUSION_SESSION_METRIC_COLLECTOR_T *collector, bool *removes)
	Indicates whether metrics with no matches should be removed.
bool	diffusion_session_metric_collector_exports_to_prometheus (DIFFUSION_SESSION_METRIC_COLLECTOR_T *collector, bool *exports_to_prometheus)
	Indicates whether the metric collector exports to Prometheus.
bool	diffusion_session_metric_collector_maximum_groups (DIFFUSION_SESSION_METRIC_COLLECTOR_T *collector, int *maximum_groups)
	Limit the number of groups maintained by this metric collector.
bool	diffusion_session_metric_collector_get_group_by_properties (DIFFUSION_SESSION_METRIC_COLLECTOR_T *collector, LIST_T **group_by)
	Returns the list of properties to group by.
bool	diffusion_session_metric_collector_compare (DIFFUSION_SESSION_METRIC_COLLECTOR_T *collector_1, DIFFUSION_SESSION_METRIC_COLLECTOR_T *collector_2)
	Compares two session metric collectors.

Detailed Description

Function Documentation

diffusion_session_metric_collector_compare()

bool diffusion_session_metric_collector_compare	(	DIFFUSION_SESSION_METRIC_COLLECTOR_T *	collector_1,
		DIFFUSION_SESSION_METRIC_COLLECTOR_T *	collector_2 )

Compares two session metric collectors.

Parameters

collector_1	a session metric collector
collector_2	another session metric collector

Returns

true if both session metric collectors are identical.

Since

6.7

diffusion_session_metric_collector_exports_to_prometheus()

bool diffusion_session_metric_collector_exports_to_prometheus	(	DIFFUSION_SESSION_METRIC_COLLECTOR_T *	collector,
		bool *	exports_to_prometheus )

Indicates whether the metric collector exports to Prometheus.

Parameters

collector	the session 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_session_metric_collector_free()

void diffusion_session_metric_collector_free

(

DIFFUSION_SESSION_METRIC_COLLECTOR_T *

collector

)

Free a session metric collector.

Parameters

collector

the session metric collector

Since

6.7

diffusion_session_metric_collector_get_group_by_properties()

bool diffusion_session_metric_collector_get_group_by_properties	(	DIFFUSION_SESSION_METRIC_COLLECTOR_T *	collector,
		LIST_T **	group_by )

Returns the list of properties to group by.

Parameters

collector	the session metric collector
group_by	the variable that will receive the list value if present

Returns

true if the collector is valid and extracted the value

Since

6.7

diffusion_session_metric_collector_get_name()

bool diffusion_session_metric_collector_get_name	(	DIFFUSION_SESSION_METRIC_COLLECTOR_T *	collector,
		char **	name )

Returns the name of the session metric collector.

Parameters

collector	the session 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_session_metric_collector_get_session_filter()

bool diffusion_session_metric_collector_get_session_filter	(	DIFFUSION_SESSION_METRIC_COLLECTOR_T *	collector,
		char **	session_filter )

Returns the session filter of the session metric collector.

Parameters

collector	the session metric collector
session_filter	the variable that will receive the session filter if present

Returns

true if the collector is valid and extracted the value

Since

6.7

diffusion_session_metric_collector_maximum_groups()

bool diffusion_session_metric_collector_maximum_groups	(	DIFFUSION_SESSION_METRIC_COLLECTOR_T *	collector,
		int *	maximum_groups )

Limit the number of groups maintained by this metric collector.

Session 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.

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

Parameters

collector	the session 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

diffusion_session_metric_collector_removes_metrics_with_no_matches()

bool diffusion_session_metric_collector_removes_metrics_with_no_matches	(	DIFFUSION_SESSION_METRIC_COLLECTOR_T *	collector,
		bool *	removes )

Indicates whether metrics with no matches should be removed.

Parameters

collector	the session metric collector
removes	the variable that will receive the bool value if present

Returns

true if the collector is valid and extracted the value

Since

6.7