IBM® Tivoli® Netcool/OMNIbus Probe for Message Bus 13.0 Reference Guide September 25, 2020 IBM SC27-8701-14 Note Before using this information and the product it supports, read the information in Appendix A, “Notices and Trademarks,” on page 103. Edition notice This edition (SC27-8701-14) applies to version 13.0 of IBM Tivoli Netcool/OMNIbus Probe for Message Bus and to all subsequent releases and modifications until otherwise indicated in new editions. This edition replaces SC27-8701-13. © Copyright International Business Machines Corporation 2015, 2020. US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. Contents About this guide.................................................................................................... v Document control page................................................................................................................................v Conventions used in this guide.................................................................................................................... x Chapter 1. Probe for Message Bus.......................................................................... 1 Summary...................................................................................................................................................... 1 Installing probes.......................................................................................................................................... 4 Migrating to the Probe for Message Bus......................................................................................................4 Identifying new and changed features of the Probe for Message Bus................................................. 4 Configuring the probe.................................................................................................................................. 7 Enabling the max_line_length property.................................................................................................8 Enabling the max_http_payload_size property.....................................................................................8 Configuring the parser with a different JsonMessageDepth...............................................................10 Generating events from a nested JSON...............................................................................................11 Specifying multiple parser configurations to parse different JSON structures..................................12 Upgrading to Probe for Message Bus version 5 or newer................................................................... 15 Using the transport module.......................................................................................................................17 Configuring the transport properties files........................................................................................... 18 Configuring the JMS transport............................................................................................................. 18 Configuring the data file transport.......................................................................................................21 Configuring the MQTT transport.......................................................................................................... 21 Configuring the Web Socket transport.................................................................................................23 Configuring the Web Hook transport................................................................................................... 33 Configuring the Cometd transport....................................................................................................... 41 Configuring the socket transport......................................................................................................... 43 Configuring the Kafka transport...........................................................................................................44 Message Bus Probe integrations with event sources............................................................................... 48 Probe integration for Amazon Web Services....................................................................................... 49 Probe integration for Ciena Blue Planet MCP...................................................................................... 51 Probe integration for IBM Cloud Platform Common Services (CS) Monitoring.................................. 53 Probe integration for IBM Event Streams for IBM Cloud.................................................................... 59 Probe integration for iDirect Pulse.......................................................................................................61 Probe integration for Kafka.................................................................................................................. 62 Probe integration for Microsoft Azure Monitoring............................................................................... 65 Probe integration for Nokia 1350 OMS................................................................................................66 Probe integration for Nokia NSP.......................................................................................................... 67 Using the transformer module.................................................................................................................. 67 Using XSLT files to transform events................................................................................................... 67 Using the transformer testing tool.......................................................................................................70 Configuring the transformer definition file.......................................................................................... 71 Using the XML validation tool...............................................................................................................73 Running the probe..................................................................................................................................... 73 Data acquisition......................................................................................................................................... 73 Peer-to-peer failover functionality...................................................................................................... 73 HTTP/HTTPS command interface........................................................................................................74 Properties and command line options...................................................................................................... 76 Properties and command line options provided by the Java Probe Integration Library (probe-sdk- java) version 11.0................................................................................................................................. 82 Elements.................................................................................................................................................... 85 Error messages.......................................................................................................................................... 89 iii Common error messages...........................................................................................................................90 ProbeWatch messages.............................................................................................................................. 94 Using the probe with the Gateway for Message Bus................................................................................ 94 Requirements....................................................................................................................................... 94 Sample implementation using JMS..................................................................................................... 95 Frequently asked questions...................................................................................................................... 96 Troubleshooting......................................................................................................................................... 96 Known issues with the Probe for Message Bus........................................................................................ 97 Appendix A. Notices and Trademarks................................................................. 103 Notices..................................................................................................................................................... 103 Trademarks.............................................................................................................................................. 104 iv About this guide The following sections contain important information about using this guide. 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.