![]() |
Diffusion C API 6.12.0
|
Allows a client to configure metric collectors. More...
Data Structures | |
struct | diffusion_metrics_put_session_metric_collector_params_s |
Structure supplied when issuing a diffusion_metrics_put_session_metric_collector call. More... | |
struct | diffusion_metrics_put_topic_metric_collector_params_s |
Structure supplied when issuing a diffusion_metrics_put_topic_metric_collector call. More... | |
struct | diffusion_metrics_remove_session_metric_collector_params_s |
Structure supplied when issuing a diffusion_metrics_remove_session_metric_collector call. More... | |
struct | diffusion_metrics_remove_topic_metric_collector_params_s |
Structure supplied when issuing a diffusion_metrics_remove_topic_metric_collector call. More... | |
struct | diffusion_metrics_list_session_metric_collectors_params_s |
Structure supplied when issuing a diffusion_metrics_list_session_metric_collectors call. More... | |
struct | diffusion_metrics_list_topic_metric_collectors_params_s |
Structure supplied when issuing a diffusion_metrics_list_topic_metric_collectors call. More... |
Typedefs | |
typedef struct DIFFUSION_SESSION_METRIC_COLLECTOR_BUILDER_T | DIFFUSION_SESSION_METRIC_COLLECTOR_BUILDER_T |
Opaque Session Metric Collector Builder struct. | |
typedef struct DIFFUSION_SESSION_METRIC_COLLECTOR_T | DIFFUSION_SESSION_METRIC_COLLECTOR_T |
Opaque Session Metric Collector struct. | |
typedef struct DIFFUSION_TOPIC_METRIC_COLLECTOR_BUILDER_T | DIFFUSION_TOPIC_METRIC_COLLECTOR_BUILDER_T |
Opaque Topic Metric Collector Builder struct. | |
typedef struct DIFFUSION_TOPIC_METRIC_COLLECTOR_T | DIFFUSION_TOPIC_METRIC_COLLECTOR_T |
Opaque Topic Metric Collector struct. | |
typedef int(* | session_metric_collector_put_cb) (void *context) |
callback when a session metric collector has been set on the server. | |
typedef int(* | session_metric_collector_remove_cb) (void *context) |
callback when a session metric collector has been removed from the server. | |
typedef int(* | session_metric_collector_list_cb) (const LIST_T *session_metric_collectors, void *context) |
callback when the list of session metric collectors has been retrieved from the server. | |
typedef int(* | topic_metric_collector_put_cb) (void *context) |
callback when a topic metric collector has been set on the server. | |
typedef int(* | topic_metric_collector_remove_cb) (void *context) |
callback when a topic metric collector has been removed from the server. | |
typedef int(* | topic_metric_collector_list_cb) (const LIST_T *topic_metric_collectors, void *context) |
callback when the list of topic metric collectors has been retrieved from the server. | |
typedef struct diffusion_metrics_put_session_metric_collector_params_s | DIFFUSION_METRICS_PUT_SESSION_METRIC_COLLECTOR_PARAMS_T |
Structure supplied when issuing a diffusion_metrics_put_session_metric_collector call. | |
typedef struct diffusion_metrics_put_topic_metric_collector_params_s | DIFFUSION_METRICS_PUT_TOPIC_METRIC_COLLECTOR_PARAMS_T |
Structure supplied when issuing a diffusion_metrics_put_topic_metric_collector call. | |
typedef struct diffusion_metrics_remove_session_metric_collector_params_s | DIFFUSION_METRICS_REMOVE_SESSION_METRIC_COLLECTOR_PARAMS_T |
Structure supplied when issuing a diffusion_metrics_remove_session_metric_collector call. | |
typedef struct diffusion_metrics_remove_topic_metric_collector_params_s | DIFFUSION_METRICS_REMOVE_TOPIC_METRIC_COLLECTOR_PARAMS_T |
Structure supplied when issuing a diffusion_metrics_remove_topic_metric_collector call. | |
typedef struct diffusion_metrics_list_session_metric_collectors_params_s | DIFFUSION_METRICS_LIST_SESSION_METRIC_COLLECTORS_PARAMS_T |
Structure supplied when issuing a diffusion_metrics_list_session_metric_collectors call. | |
typedef struct diffusion_metrics_list_topic_metric_collectors_params_s | DIFFUSION_METRICS_LIST_TOPIC_METRIC_COLLECTORS_PARAMS_T |
Structure supplied when issuing a diffusion_metrics_list_topic_metric_collectors call. |
Allows a client to configure metric collectors.
Diffusion servers provide metrics which are made available in several ways:-
Metric collectors allow custom aggregation of metrics that are relevant to your application. There are no default metric collectors, only the ones that you create.
There are two types of metric collector: Session Metric Collectors and Topic Metric Collectors.
For full details regarding the configuration and operation of metric collectors see the user manual.
These can be configured to record metric data for a subset of all sessions, specified with a session filter.
The set of metrics recorded by each session metric collector is the same as those recorded for the whole server. For full details of session metrics, see the table in the user manual.
If the session filters of two different session metric collectors select the same session, both will record metrics for that session. It is only valid to add the metrics of different session metric collectors if their session filters select distinct sets of sessions.
You can optionally group the sessions within a collector by session properties.
These can be configured to record metric data for a subset of all topics, specified with a topic selector.
You can optionally group the topics within a collector by topic type.
The set of metrics recorded by each topic metric collector is the same as those recorded for the whole server. For full details of topic metrics, see the table in the user manual.
If the topic selectors of two different topic metric collectors select the same topic, both will record metrics for that topic. It is only valid to add the metrics of different topic metric collectors if their topic selectors select distinct sets of topics.
The following access control restrictions are applied:
put
or remove
a session metric collector, a session needs the CONTROL_SERVER
global permission. put
or remove
a topic metric collector, a session needs the CONTROL_SERVER
global permission. list
session metric collectors or topic metric collectors
, a session needs the VIEW_SERVER
global permission.