Identifying new and changed features of the Probe for Message Bus
When migrating from the legacy probe to the Probe for Message Bus, there are some important points to note about the features that are available and the properties that are required to configure them:
- Some properties form the legacy probe have been deprecated in the Probe for Message Bus.
- Some features, and the properties required to configure them, have been added to the Probe for Message Bus.
The following table compares the features, and the properties required to configure them, of the legacy XML Probe and the Probe for Message Bus.
| Legacy XML Probe property |
Message Bus Probe property |
Functional description |
|---|---|---|
ConnectionCheckInterval |
HeartbeatInterval |
Interval between successive connection status checks. |
Not available in the legacy probe. |
Cookie |
HTTP cookie name to be retrieved from the probe store. |
DisconnectionOnInactivity |
Inactivity |
Indicates whether the probe disconnects from the target system when the inactivity timeout period is reached. |
Not available in the legacy probe. |
EnableSSL |
Indicates whether SSL connectivity. |
FlushBufferInterval |
FlushBufferInterval |
Interval at which the probe flushes all alerts in the buffer to the ObjectServer. |
Not available in the legacy probe. |
Host |
Host name or IP address of the instance of the XML or JSON event source to which the probe connects. |
Inactivity |
Inactivity |
Time (in seconds) that the probe allows the port to receive no incoming data before disconnecting. |
Not available in the legacy probe. |
InitialResync |
Indicates whether the probe requests all active alarms from the host server on startup. |
| Not available in the legacy probe. |
JsonNestedPayload |
Indicates whether nested parsing on JSON data is enabled. You can specify either XML or JSON tree structure. |
Not available in the legacy probe. |
KeyStore |
Location of the keystore file that contains the client certificate for the SSL and trusted authority certificate. |
Not available in the legacy probe. |
KeyStorePassword |
Password required to access the certificate specified by the Keystore property. |
Not available in the legacy probe. |
MaxEventQueueSize |
Maximum number of events that can be queued between the non native process and the ObjectServer. |
Not available in the legacy probe. |
MessagePayload |
Type of message payload, either XML or the JSON tree. |
Not available in the legacy probe. |
Password |
Password associated with the Username property for logging into the XML event source. |
Not available in the legacy probe. |
Port |
Port of the instance of the XML or JSON event source to which the probe connects. |
Not available in the legacy probe. |
ResyncInterval |
Interval at which the probe makes successive resynchronization requests. |
Retry |
RetryCount and RetryInterval |
Indicates whether the probe retries connecting to the target system before shutting down. |
StreamCapture |
StreamCapture |
Indicates whether or not the probe stores the XML or JSON event data in a stream capture file. |
StreamCaptureFile |
StreamCaptureFile |
Location of the stream capture file. |
TransformerFile |
TransformerFile |
Location of the transformer properties file. |
TransportFile |
TransportFile |
Location of the transport properties file. |
TransportType |
TransportType |
Transport method to be used or the name of the transport module class to use. |
Not available in the legacy probe. |
Username |
User account for logging into the XML or JSON event source. |
Not available in the legacy probe. |
WebSocketID (Deprecated in version 5.0 of the Message Bus Probe.) |
JSON field name where the WebSocket subscription ID is stored as a field value in the response message during a subscription request. Note: This property is deprecated in version 5.0 of Message Bus Probe. To enable the probe to
extract multiple attributes from incoming JSON data, use the keepTokens
property in the restWebSocketTransport.properties file.
|