Configuration Guide
Automatic Monitoring Options

The Monitoring Options below apply to a given UM context. You can override the default values of these options and apply monitoring option values to all UM contexts (transports and event queues) with the following environment variables.

  • LBM_MONITOR_INTERVAL
  • LBM_MONITOR_TRANSPORT
  • LBM_MONITOR_TRANSPORT_OPTS
  • LBM_MONITOR_APPID

These variables will not override any Monitoring Options you explicitly set. The environment variables only override Monitoring Options default values.

If you do not specify any monitoring options either in a UM configuration file or via lbm_context_attr_setopt() calls, no monitoring will occur. However, if you then set the LBM_MONITOR_INTERVAL environment variable to 5, you will turn on automatic monitoring for every UM context your application creates at 5 second intervals. If you then set monitor_interval to 10 for a particular context, all transport sessions in that context will be monitored every 10 seconds.

For XML configuration files, you can configure an automatic monitoring context by setting the <context> attribute name=infa_statistics_context.

See also Automatic Monitoring in the Ultra Messaging Operations Guide for more information about this feature.


Reference  <-


monitor_appid (context)  <-

An application ID string used by automatic monitoring to identify the application generating the statistics.
See Automatic Monitoring.
Scope: context
Type: string
When to Set: Can only be set during object initialization.
Version: This option was implemented in LBM 3.4/UME 2.1.


monitor_appid (event_queue)  <-

An application ID string used by automatic monitoring to identify the application generating the statistics.
See Automatic Monitoring.
Scope: event_queue
Type: string
When to Set: Can only be set during object initialization.
Version: This option was implemented in LBM 3.4/UME 2.1.


monitor_interval (context)  <-

Interval at which automatic monitoring retrieves the statistics for all transport sessions on a context.
Setting this option to zero (the default) disables the automatic monitoring of a context's transport sessions.
Scope: context
Type: lbm_ulong_t
Units: seconds
Default value: 0
When to Set: Can only be set during object initialization.
Version: This option was implemented in LBM 3.4/UME 2.1.


monitor_interval (event_queue)  <-

Interval at which automatic monitoring retrieves the statistics for an event queue.
Setting this option to zero (the default) disables the automatic monitoring of an event queue. When monitoring Event Queue statistics you must enable the Event Queue UM Configuration Options, queue_age_enabled (event_queue), queue_count_enabled (event_queue) and queue_service_time_enabled (event_queue). UM disables these options by default, which produces no event queue statistics.
Scope: event_queue
Type: lbm_ulong_t
Units: seconds
Default value: 0
When to Set: Can only be set during object initialization.
Version: This option was implemented in LBM 3.4/UME 2.1.


monitor_interval (receiver)  <-

Interval at which automatic monitoring retrieves the topic interest information for all receivers using a UM configuration file with this option set to a non-zero value.
Topic interest information contains source and topic information if the receiver has joined the source transport session. If the topic interest information is blank, the receiver has not joined a source transport session. UM System Monitoring uses this information to monitor the number of subscribed topics. Setting this option to zero (the default) disables the automatic monitoring of receiver interest.
See Automatic Monitoring.
Scope: receiver
Type: lbm_ulong_t
Units: seconds
Default value: 0
When to Set: Can only be set during object initialization.
Version: This option was implemented in UM 6.5.


monitor_interval (wildcard_receiver)  <-

Interval at which automatic monitoring retrieves the topic interest information for all receivers interested in topics that match the wildcard receiver pattern.
Topic interest information contains source and topic information if the receiver has joined the source transport session. If the topic interest information is blank, the receiver has not joined a source transport session. UM System Monitoring uses this information to monitor the number of subscribed topics. Setting this option to zero (the default) disables the automatic monitoring of a wildcard receiver interest.
See Automatic Monitoring.
Scope: wildcard_receiver
Type: lbm_ulong_t
Units: seconds
Default value: 0
When to Set: Can only be set during object initialization.
Version: This option was implemented in UM 6.5.


monitor_transport (context)  <-

The LBMMON transport module to be used for automatic monitoring.
See Automatic Monitoring.
Scope: context
Type: int
When to Set: Can only be set during object initialization.
Version: This option was implemented in LBM 3.4/UME 2.1.

String value Integer value Description
"lbm" LBM_CTX_ATTR_MON_TRANSPORT_LBM Use the LBMMON lbm transport module. Default for all.
"lbmsnmp" LBM_CTX_ATTR_MON_TRANSPORT_LBMSNMP

Use the LBMMON lbmsnmp transport module. This value is required if you use the UM SNMP Agent.


monitor_transport (event_queue)  <-

The LBMMON transport module to be used for automatic monitoring.
See Automatic Monitoring.
Scope: event_queue
Type: int
When to Set: Can only be set during object initialization.
Version: This option was implemented in LBM 3.4/UME 2.1.

String value Integer value Description
"lbm" LBM_CTX_ATTR_MON_TRANSPORT_LBM Use the LBMMON lbm transport module. Default for all.
"lbmsnmp" LBM_CTX_ATTR_MON_TRANSPORT_LBMSNMP

Use the LBMMON lbmsnmp transport module. This value is required if you use the UM SNMP Agent.


monitor_transport_opts (context)  <-

An option string to be passed to the LBMMON transport module for automatic monitoring. The format of the option string is one or more instances of scope|optname=optval separated by semicolons.
For example:
context monitor_transport_opts context|resolver_multicast_interface="en0";source|transport=lbt-rm
Note
Some UM options specify interfaces, which can be done by supplying the device name of the interface. Special care must be taken when including this option in XML configuration files. See Interface Device Names and XML for details.
See The LBM Transport Module for more information about Transport Options. (Options for the lbm transport module and the lbmsnmp transport module are identical.)
Scope: context
Type: string
When to Set: Can only be set during object initialization.
Version: This option was implemented in LBM 3.4/UME 2.1.


monitor_transport_opts (event_queue)  <-

An option string to be passed to the LBMMON transport module for automatic monitoring. The format of the option string is one or more instances of scope|optname=optval separated by semicolons.
For example:
event_queue monitor_transport_opts context|resolver_multicast_interface="en0";source|transport=lbt-rm
Note
Some UM options specify interfaces, which can be done by supplying the device name of the interface. Special care must be taken when including this option in XML configuration files. See Interface Device Names and XML for details.
See The LBM Transport Module for more information about Transport Options. (Options for the lbm transport module and the lbmsnmp transport module are identical.)
Scope: event_queue
Type: string
When to Set: Can only be set during object initialization.
Version: This option was implemented in LBM 3.4/UME 2.1.