QUERY_MDS_STATISTICS

QUERY_MDS_STATISTICS returns management services statistics. This verb can be used to gauge the level of MDS routing traffic.

VCB Structure

typedef struct query_mds_statistics
{
        unsigned short  opcode;             /* verb operation code         */
        unsigned char   reserv2;            /* reserved                    */
        unsigned char   format;             /* format                      */
        unsigned short  primary_rc;         /* primary return code         */
        unsigned long   secondary_rc;       /* secondary return code       */
        unsigned long   alerts_sent;        /* number of alert sends       */
        unsigned long   alert_errors_rcvd;  /* error messages received     */
                                            /* for alert sends             */
        unsigned long   uncorrelated_alert_errors;
                                            /* uncorrelated alert          */
                                            /* errors received             */
        unsigned long   mds_mus_rcvd_local; /* number of MDS_MUs received  */
                                            /* from local applications     */
        unsigned long   mds_mus_rcvd_remote;
                                            /* number of MDS_MUs received  */
                                            /* from remote applications    */
        unsigned long   mds_mus_delivered_local;
                                            /* num of MDS_MUs delivered    */
                                            /* to local applications       */
        unsigned long   mds_mus_delivered_remote;
                                            /* num of MDS_MUs              */
                                            /* delivered to remote appls   */
        unsigned long   parse_errors;       /* number of MDS_MUs received  */
                                            /* with parse errors           */
        unsigned long   failed_deliveries;  /* number of MDS_MUs where     */
                                            /* delivery failed             */
        unsigned long   ds_searches_performed;
                                            /* number of DS searches done  */
        unsigned long   unverified_errors;  /* number of unverified errors */
        unsigned char   reserva[20];        /* reserved                    */
} QUERY_MDS_STATISTICS;

Supplied Parameters

The application supplies the following parameters:

opcode: AP_QUERY_MDS_STATISTICS
format: Identifies the format of the VCB. Set this field to zero to specify the version of the VCB listed above.

Returned Parameters

If the verb executes successfully, the Program returns the following parameters:

primary_rc: AP_OK
alerts_sent: Number of locally originated alerts sent using the MDS transport system.
alert_errors_rcvd: Number of error messages received by MDS indicating a delivery failure for a message containing an alert.
uncorrelated_errors_rcvd: Number of error messages received by MDS indicating a delivery failure for a message containing an alert. Delivery failure occurs when the error message could not be correlated to an alert on the MDS send alert queue. MDS maintains a fixed-size queue where it caches alerts sent to the problem determination focal point. Once the queue reaches maximum size, the oldest alert will be discarded and replaced by the new alert. If a delivery error message is received, MDS attempts to correlate the error message to a cached alert so that the alert can be held until the problem determination focal point is restored.
Note: The two counts, alert_errors_rcvd and uncorrelated_errors_rcvd are maintained such that the size of the send alert queue can be tuned. An increasing uncorrelated_errors_rcvd over time indicates that the send alert queue size is too small.
mds_mus_rcvd_local: Number of MDS_MUs received from local applications.
mds_mus_rcvd_remote: Number of MDS_MUs received from remote nodes using the MDS_RECEIVE and MSU_HANDLER transaction programs.
mds_mus_delivered_local: Number of MDS_MUs successfully delivered to local applications.
mds_mus_delivered_remote: Number of MDS_MUs successfully delivered to a remote node using the MDS_SEND transaction program.
parse_errors: Number of MDS_MUs received that contained header format errors.
failed_deliveries: Number of MDS_MUs this node failed to deliver.
ds_searches_performed: Reserved.
unverified_errors: Reserved.

If the verb does not execute because the node has not yet been started, the Program returns the following parameter:

primary_rc: AP_NODE_NOT_STARTED

If the verb does not execute because of a system error, the Program returns the following parameter:

primary_rc: AP_UNEXPECTED_SYSTEM_ERROR