Document control page

Table 1. Document modification history

Document version

Publication date

Comments

SC27-8701-00

December 10, 2015

First IBM publication.

The Probe for Message Bus addresses the following enhancement requests:

RFE 59587: Request to provide filtering support on the Java Message Service (JMS) Transport Module.

RFE 71751: Request to add support for the REST API protocol within the JMS Transport Module.

RFE 63631: Request to enhance the event parser to process JSON messages.

SC27-8701-01

July 28, 2016

Version updated to 2.0 in Summary.

Updated Elements with new element $resync_event.

Updated Enabling the max_line_length property and Enabling the max_http_payload_size property command from %JAVA_USED% to %JAVA_EXEC_USED%.

Updated Properties and command line options. Added descriptions for the following property: JsonNestedPayload.

Version 2.0 of the probe addresses the following enhancement request:

RFE 80771: Request to enhance the Probe for Message Bus for JSON parsing.

SC27-8701-02

November 24, 2016

Version updated to 3.0 in Summary.

The following topics added:

Descriptions for the following WebSocket transport properties were added to Configuring the Web Socket transport:
  • httpHeaders
  • refreshRetryCount
  • securityProtocol
  • webSocketRefreshInterval
  • webSocketRefreshMessage
  • webSocketPeristentURI
Descriptions for the following probe properties were added to Properties and command line options:
  • JsonMessageDepth
  • JsonNestedHeader
  • MessageHeader
  • RecordData

SC27-8701-03

March 14, 2017

Version updated to 4.0 in Summary.

Support for the disconnectProbe and shutdownProbe commands using HTTP added. See HTTP/HTTPS command interface.

Properties and command line options provided by the Java Probe Integration Library (probe-sdk-java) version 11.0 updated to reflect the probe's usage of version 11 of the Probe Framework.

Error message added to Error messages.

Issue added to Known issues with the Probe for Message Bus.

SC27-8701-04

July 20, 2017

Version updated to 5.0 in Summary.

Added support for Ciena's Blue Planet MCP Release 17.02.

Ciena Blue Planet MCP added.

Description of the deprecated WebSocketId property removed from Properties and command line options.

Addition of the keepTokens property to the restWebSocketTransport.properties file to enable the probe to extract multiple attributes from the incoming JSON data.

Addition of the webSocketSubscribeMessage property to the restWebSocketTransport.properties file to specify the message that the probe sends after successfully connecting through the WebSocket channel.

Addition of the following properties to the restWebSocketTransport.properties file to enable the overriding of the global HTTP header settings:
  • loginRequestHeaders
  • loginRefreshHeaders
  • logoutRequestHeaders
  • resyncRequestHeaders
  • subscribeRequestHeaders
  • subscribeRefreshHeaders
  • webSocketSubscribeMessage

SC27-8701-05

August 18, 2017

Guide updated to describe how to upgrade to version 5 of the probe to make use of the enhanced JSON functionality.

The following topics updated:

SC27-8701-06

November 23, 2017

Version updated to 6.0 in Summary.

Using the transport module updated.

WebSocket transport enhanced to support OAuth authentication and extended to replace the HTTP transport for alarm subscription and notification.

Known issues with the Probe for Message Bus has been updated.

The guide has also been reorganized for clarity.

SC27-8701-07

April 12, 2018

Version updated to 7.0 in Summary.

Support added for Kafka.

The following topic was added Kafka:

IBM Cloud Platform Common Services (CS) Monitoring updated.

SC27-8701-08

October 11, 2018

Version updated to 8.0 in Summary.

Updated the table in Using the transport module.

Description for webSocketHeaders added to Configuring the Web Socket transport.

Updated Kafka.

Descriptions for respondWithContent, validateBodySyntax, validateRequestURI, and idleTimeout added to Configuring the webhook v1 transport.

Added the following topics:

SC27-8701-09

February 28, 2019

Version updated to 9.0 in Summary.

Message Bus Probe integrations with event sources added.

Amazon Web Services and Microsoft Azure Monitoring added.

HTTP/HTTPS transport removed from the Message Bus Probe, the functionality being replaced by the Webhook Transport.

SC27-8701-10

August 29, 2019

Version updated to 10.0 in Summary.

Probe updated to enable the transport properties file encryption mechanism.

Descriptions for new Webhook transport properties added to Configuring the webhook v1 transport

Running the probe with the Webhook transport and HTTP transport updated to provide event sender as a token, adding HTTP headers to be parsed into Message payload. Note: XML payload is currently not supported.

Details about the integration with Nokia NSP moved to the new Probe Integration for Nokia NSP Reference Guide.

SC27-8701-11

January 31, 2020

Version updated to 11.0 in Summary.

Message Bus Probe integrations with event sources updated.

Ciena Blue Planet MCP updated.

IBM Event Streams for IBM Cloud added.

Kafka updated.

Microsoft Azure Monitoring renamed.

Troubleshooting added.

SC27-8701-12

March 20, 2020

Version updated to 12.0 in Summary.

IBM Event Streams for IBM Cloud updated.

SC27-8701-13

April 30, 2020

Properties and command line options updated.

SC27-8701-14

September 25, 2020

Version updated to 13.0 in Summary.

SC27-8701-15

March 19, 2021

Version updated to 14.0 in Summary.

Description for the TransportQueueSize added to Properties and command line options.

Properties and command line options updated.

Version 14 of the probe addresses the following APARs:

IJ27018: The fix for MessagePayload in IJ16982 is now extended to MessageHeader property.

IJ24667: Introduced the TransportQueueSize property which allows you to increase the queue size for raw events.

IJ24671: The probe now creates a ProbeWatch message to indicate that the processing of all resync events have been completed.

IJ24668: Fixed the NumberFormatException issue during resynchronization against Blue Planet MCP.

SC27-8701-16

April 16, 2021

Version updated to 15.0 in Summary.

Cisco Evolved Programmable Network Manager added.

Version 15.0 of the probe addresses the following enhancement request:

RFE 141961: Partial resync based on timestamp and iterator ID with Cisco EPNM v3.0.

Version 15 also addresses the following APARs:

IJ30130: Support added for the cleanStart option in the Kafka consumer specific properties. If set to true, probe will search for the last offsets and collect only new events upon subscribe. The default is false.

IJ30507: Post login request properties added to the WebSocket transport to allow users to configure the probe to send another HTTP request before initiating the WebSocket server.

SC27-8701-17

June 18, 2021

Version updated to 16.0 in Summary.

Support for integrating with Apache Pulsar added.

Configuring the Apache Pulsar transport added.

Support for the CometD transport removed.

SC27-8701-18

September 30, 2021

Version updated to 17.0 in Summary.

Apache Pulsar updated.

Addition of the subscriptionType property to the pulsarConsumer.properties file.

SC27-8701-19

November 5, 2021

Version updated to 18.0 in Summary.

SC27-8701-20

June 29, 2022

Version updated to 19.0 in Summary.

New Webhook V2 transport protocol added, see Configuring the webhook v2 transport.

Properties and command line options updated.

Updated dependency components Transport Module Common Integration Library (common-transportmodule-35_0)

Added IBM SevOne Network Performance Management (NPM) probe integration for Cloud Pak for AIOps

SC27-8701-21

September 28, 2022

Version updated to 20.0 in Summary.

Updated dependency components Transport Module Common Integration Library (common-transportmodule-35_0)

Added IBM Turbonomic probe integration for Cloud Pak for AIOps

SC27-8701-22

December 14, 2022

Version updated to 21.0 in Summary.

Updated dependency components Transport Module Common Integration Library (common-transportmodule-36_0)

SC27-8701-23

March 29, 2023

Version updated to 22.0 in Summary.

Updated dependency components Transport Module Common Integration Library (common-transportmodule-37_0)

Support added for integrating with Nokia Altiplano 22.12.

SC27-8701-24

September 27, 2023

Version updated to 23.0 in Summary.

Updated dependency components Transport Module Common Integration Library (common-transportmodule-38_4)

Support added for integrating with Nokia NSP 23.4.

Enhancements to the integration with Nokia Altiplano Access Controller

SC27-8701-25

December 6, 2023

Version updated to 23.1 in Summary.

Troubleshooting updated.

SC27-8701-26

March 27, 2024

Version updated to 24 in Summary.

Support added for integrating with Nokia Altiplano 23.12.

SC27-8701-27

July 31, 2024

Version updated to 25 in Summary.

Accessing the OpenID Connect (OIDC) server added.

Updated dependency components Transport Module Common Integration Library (common-transportmodule-40_0)

Note: The IBM Tivoli Netcool/OMNIbus Probe for Message Bus was previously documented in the IBM® Tivoli® Netcool/OMNIbus Probe for Message Bus reference guide (SC14-7649-04).