Viewing MQ Connectivity statistics by using REST Monitoring APIs

System administrators can view destination mapping rule-related statistics by using a REST Monitoring API.

System administrators can view destination mapping rule-related statistics by using a REST Monitoring API, or by using the Amlen WebUI. For more information about using the Amlen WebUI to view destination mapping rule-related statistics, see Viewing MQ Connectivity statistics by using the Amlen WebUI. For more information about the predefined queries that you can run, see MQ Connectivity monitoring.

Destination mapping rule-related monitoring statistics can be created by using the Eclipse Amlen REST API GET method . To create destination mapping rule-related monitoring statistics, complete the following steps:
  1. Use the Eclipse Amlen REST API GET method with the following Eclipse Amlen monitoring URI:

    http://<admin-endpoint-IP:Port>/ima/v1/monitor/<Object Type>

  2. Provide query parameters requesting the statistics that you want returned in the JSON payload. The following example uses cURL to create MQConnectivity-related statistics: 
    curl -X GET http://127.0.0.1:9089/ima/v1/monitor/DestinationMappingRule?Name=Name%26RuleType=RuleType%26Association=Association%26StatType=StatType%26ResultCount=ResultCount

    Where:

    • Name
      Optional.
      Specifies the name of the destination mapping rule to collect data about.
      You can use an asterisk (*) as a wildcard to specify a group of destination mapping rules. For example, to view the status of all destination mapping rules that start with MQ, use MQ*
      The default value is *
    • RuleType
      Optional.
      Specifies the type of rule to return monitoring data for.
      You can specify one of the following values:
      • IMATopicToMQQueue
        Returns destination mapping rules of the type Eclipse Amlen topic to IBM® MQ queue.
      • IMATopicToMQTopic
        Returns destination mapping rules of the type Eclipse Amlen topic to IBM MQ topic.
      • MQQueueToIMATopic
        Returns destination mapping rules of the type IBM MQ queue to Eclipse Amlen topic.
      • MQTopicToIMATopic
        Returns destination mapping rules of the type IBM MQ topic to Eclipse Amlen topic.
      • IMATopicSubtreeToMQQueue
        Returns destination mapping rules of the type Eclipse Amlen topic subtree to IBM MQ queue.
      • IMATopicSubtreeToMQTopic
        Returns destination mapping rules of the type Eclipse Amlen topic subtree to IBM MQ topic.
      • IMATopicSubtreeToMQTopicSubtree
        Returns destination mapping rules of the type Eclipse Amlen topic subtree to IBM MQ topic subtree.
      • MQTopicSubtreeToIMATopic
        Returns destination mapping rules of the type IBM MQ topic subtree to Eclipse Amlen topic.
      • MQTopicSubtreeToIMATopicSubtree
        Returns destination mapping rules of the type IBM MQ topic subtree to Eclipse Amlen topic subtree.
      • IMAQueueToMQQueue
        Returns destination mapping rules of the type Eclipse Amlen queue to IBM MQ queue.
      • IMAQueueToMQTopic
        Returns destination mapping rules of the type Eclipse Amlen queue to IBM MQ topic.
      • MQQueueToIMAQueue
        Returns destination mapping rules of the type IBM MQ queue to Eclipse Amlen queue.
      • MQTopicToIMAQueue
        Returns destination mapping rules of the type IBM MQ topic to Eclipse Amlen queue.
      • MQTopicSubtreeToIMAQueue
        Returns destination mapping rules of the type IBM MQ topic subtree to Eclipse Amlen queue.
      • Any
        Returns destination mapping rules of all types.
        This value is the default value.
    • Association
      Optional.
      Specifies the queue manager connection that the destination mapping rule must be associated with.
      You can use an asterisk (*) as a wildcard to specify a group of queue manager connections. For example, to view the status of all destination mapping rules that are associated with queue managers that start with MQ, use MQ*
      The default value is *
    • StatType
      Specifies the type of data to order the results by
      This value can be one of the following values:
      • CommitCount
        Orders the monitoring data by the number of commit operations that are completed for the destination mapping rule. One commit operation can commit many messages.
        This value is the default value.
      • RollbackCount
        Orders the monitoring data by the number of rollback operations that are completed for the destination mapping rule.
      • PersistentCount
        Orders the monitoring data by the number of persistent messages that are sent by using the destination mapping rule.
      • NonPersistentCount
        Orders the monitoring data by the number of nonpersistent messages that are sent by using the destination mapping rule.
      • CommittedMessageCount
        Orders the monitoring data by the number of messages that are transferred within the transactions.
      • Status
        Orders the monitoring data by the status of the destination mapping rule.
        The status field can be one of the following values:
        0
        Enabled - the rule is operating normally.
        1
        Disabled - the rule is not operating. The rule must be restarted by an administrator.
        2
        Reconnecting - the rule encountered a problem. Eclipse Amlen is attempting to restart the rule.
        3
        Starting - the rule is being activated.
    • ResultCount
      Optional.
      Specifies the maximum number of results to report.
      This value can be one of the following values: 10, 25, 50, 100.
      The default value is 10.
The following fields are returned:
  • RuleName
    String
    The name of the destination mapping rule that is monitored.
    QueueManagerConnection
    String
    The name of the queue manager connection that the destination mapping rule is associated with.
    CommitCount
    Numeric
    The number of commit operations that are completed for the destination mapping rule. One commit operation can commit many messages.
    RollbackCount
    Numeric
    The number of rollback operations that are completed for the destination mapping rule.
    CommittedMessageCount
    Numeric
    PersitentCount
    Numeric
    The number of persistent messages that are sent by using the destination mapping rule.
    NonpersistentCount
    Numeric
    The number of nonpersistent messages that are sent by using the destination mapping rule.
    Status
    Numeric
    The value of the status field can be one of the following values:
    • 0
      Enabled.
      The rule is operating normally.
    • 1
      Disabled.
      The rule is not operating. The rule must be restarted by an administrator.
    • 2
      Reconnecting.
      The rule encountered a problem. Eclipse Amlen is attempting to restart the rule.
    • 3
      Starting.
      The rule is being activated.
    ExpandedMessage
    String
    Additional information on the status of the destination mapping rule, including a reason code if applicable.

The following example uses cURL to show how a GET method is used to create statistics about destination mapping rules with a IMATopicToMQQueue rule type. The data is ordered by commit count:

curl -X GET http://127.0.0.1:9089/ima/v1/monitor/DestinationMappingRule?Name=*%26RuleType=IMATopicToMQQueue%26StatType=CommittedMessageCount

The following example shows a successful example response to the GET method that was used to create statistics about destination mapping rules with a IMATopicToMQQueue rule type:

{ "Version":"v1", "DestinationMappingRule": [ {"RuleName":"MyDestinationMappingRule","QueueManagerConnection":"QM1","CommitCount":1,
"RollbackCount":0,"CommittedMessageCount":0,"PersistentCount":0,"NonpersistentCount":0,"Status":3 } ] }