Monitoring and reporting

Monitoring provides a picture of the health of IBM® Watson IoT Platform - Message Gateway. You can monitor IBM Watson IoT Platform - Message Gateway to understand how it is being used, and watch for potential problems.

IBM Watson IoT Platform - Message Gateway has built-in monitoring capability in both the WebUI and REST Monitoring APIs. You can also write you own monitoring applications to monitor data remotely.

Important: If multiple users are using monitoring tasks at the same time, it has a negative performance impact on the IBM Watson IoT Platform - Message Gateway server.

Monitoring by using an external application

Nonpersistent monitoring messages are automatically published every 2 seconds from the IBM Watson IoT Platform - Message Gateway server to fixed topics that have a reserved topic root of $SYS. For example, $SYS/ResourceStatistics/<ObjectType>, where ObjectType is one of the following values: Endpoint, Topic, Memory, or Store. Subscription-based monitoring can be used by external monitoring applications. The monitoring applications must subscribe to the fixed monitoring topics or sub topics in order to receive the monitoring data that is published by IBM Watson IoT Platform - Message Gateway. To receive monitoring data, a monitoring client must subscribe to one or more $SYS/ResourceStatistics topics. Monitoring applications that are configured to subscribe to #, cannot receive messages that are published on $SYS or on a subtopic of $SYS. To subscribe to all available published monitoring data, use the number sign (#) as a wildcard to subscribe to $SYS/ResourceStatistics/#. For more information about wildcards, see Wildcards.

For High Availability, monitoring data is published only from the primary node. Monitoring data is not published during the initial node synchronization process at start time.

Monitoring by using SNMP

You can configure IBM Watson IoT Platform - Message Gateway to use Simple Network Management Protocol (SNMP) to monitor resource usage. IBM Watson IoT Platform - Message Gateway supports SNMPv2c. When SNMP is enabled, you can query IBM Watson IoT Platform - Message Gateway statistics by using an SNMP client that supports v2C.

The IBM Watson IoT Platform - Message Gateway SNMP Management Information Base (MIB) object identifier (OID) that you can use when querying the MIB is 1.3.6.1.4.1.2.6. You can download the IBM Watson IoT Platform - Message Gateway MIB files and import them in to your client for improved browsing.

You can register SNMP trap subscribers to receive alerts about IBM Watson IoT Platform - Message Gateway volatile memory and persistent store thresholds and hardware sensor notifications.

The following IBM Watson IoT Platform - Message Gateway monitoring statistics are available from the SNMP agent when the status of the IBM Watson IoT Platform - Message Gateway server is Running (production) and it is not in standby mode:
  • Runtime status of the IBM Watson IoT Platform - Message Gateway server
  • Memory
  • Store
  • Server
  • Endpoints
  • Subscriptions
  • Connections
  • Topics

When the status of the IBM Watson IoT Platform - Message Gateway server is Running (maintenance) or it is in standby mode, only the runtime status of the IBM Watson IoT Platform - Message Gateway server is available.

When a clean store operation is in progress, or the status of the IBM Watson IoT Platform - Message Gateway server is Stopped, StoreStarting, or Unknown, the server state might be the only data available.

For more information about configuring SNMP for IBM Watson IoT Platform - Message Gateway, see Configuring SNMP.

The following topics describe the different categories of monitoring data that can be reported on IBM Watson IoT Platform - Message Gateway: