- 6 minutes to read

Important

This agent has been deprecated and consolidated into the IBM MQ Monitoring Agent v7.2.0+

The standalone IBM Integration Bus Logging Agent is no longer maintained. Modern installations use the unified IBM MQ Monitoring Agent with:

  • .NET 10 (no IBM MQ Client libraries required)
  • Remote GUI configuration (no Settings.json files)
  • gMSA support and AI Diagnostics

For modern installations: See IBM MQ Prerequisites and IBM Integration Bus Logging.

Legacy v6 prerequisites below are for reference only.


Legacy: Prerequisites for the IBM Integration Bus Logging Agent (Deprecated)

Unlock seamless integration monitoring with the Nodinite IBM Integration Bus Logging Agent. This page guides you through all prerequisites for a successful installation and configuration, ensuring secure, high-performance logging and monitoring for your IBM Integration Bus environments.

✅ Centralized monitoring and logging for IBM Integration Bus
✅ Secure, scalable, and high-performance architecture
✅ Easy integration with IBM MQ and Windows environments
✅ Comprehensive troubleshooting and support resources

The Logging solution involves the following parts:

  • Emitting IBM Monitoring Events (involves changes to configuration files on your server with IBM Integration Bus workflows)
    • IBM MQ Queues as destinations for IBM Monitoring Events
  • IBM Integration Bus Logging Agent (must be installed and have access to queues)
graph LR subgraph "IIB / ACE Solution" roWCFApplication(fa:fa-globe IIB Workflow)--> roWCFTracing(fa:fa-bolt Monitoring Events
Monitoring Profile) roFolder(fa:fa-list IBM MQ Queue) roWCFTracing --> roFolder end subgraph "Nodinite Server" roPS(fa:fa-truck-pickup Nodinite Logging Agent) roFolder --> | TCP | roPS end

Architecture overview: IBM Integration Bus workflows emit monitoring events to IBM MQ queues, which are then processed by the Nodinite Logging Agent for centralized monitoring.

Log Events and Payload

  • Ensure you have one or more System Integration Solutions running in your IBM Integration Bus environment(s).

  • Configure IIB/ACE to emit Monitor Events for complete visibility.

  • The IBM Integration Bus Log Agent automatically collects all events and messages generated from IBM Integration Bus Monitor Events with a queue destination. Currently, the following queue providers are supported:

    If you need support for other queue providers, such as MQTT, please contact us—future support can be added upon request.

Verified Topic
Software Requirements
What Windows User Rights does the IBM Integration Bus Logging Agent require
What firewall settings does the Nodinite IBM Integration Bus Logging Agent require?

Software Requirements

To get started, make sure you have the following components:

  1. Windows Server

  2. .NET Framework

  3. IBM Integration Bus

    Tip

    We recommend installing the Nodinite IBM Integration Bus Logging Agent on the Nodinite application server rather than on the same server as your IBM Integration Bus solution. This approach simplifies management and helps ensure optimal performance.

  4. IBM MQ Client binaries with the .NET redistributable
    Default read ahead
    Queues with Monitoring Events must have 'Default read ahead' set to 'No'.

  5. MSDTC configured with support for XA transactions

Product Version/Edition Comment
Windows Server Windows 2025
Windows 2022
Windows 2019
Windows 2016
Windows 2012 R2
Windows 2012
.NET Framework .NET Framework 4.8 or later New 6.0 Our recommendation is .NET Framework 4.8.1 or later
IBM Integration Bus
  • 12
  • 11
  • 10
  • 9
Older versions may very well work; contact our Support if you need technical assistance configuring Nodinite against older versions of the IBM Message Broker
IBM MQ Client V9.2
V9.1
v9.0
v8.05+
v7.5+
Matching the highest version of IBM MQ in use with the IIB for the Logging
MSDTC Windows roles and features Configure MSDTC as documented with additional demand on 'XA transactions' being allowed

If you need IBM MQ Client 9.3 or later, please contact our support.

  • Versions 6.0 and later make use of the .NET Framework 4.8 or later.
  • Versions 5.4 and subsequently make use of the .NET Framework 4.6.2 or later.
  • Versions before 5.4 make use of the .NET Framework 4.5.2 or later.

Tip

Make sure to monitor the log queues using the Nodinite IBM MQ Monitoring Agent.


What Windows User Rights does the IBM Integration Bus Logging Agent require?

Privileges

The IBM Integration Bus Logging Agent requires privileges to run as a Windows Service and access rights to consume messages on queues on the configured queue managers.

Windows User Rights

The agent requires a Windows account:

What firewall settings does the Nodinite IBM Integration Bus Logging Agent require?

The Nodinite IBM Integration Bus Logging Agent consumes IIB Monitoring Events from IBM MQ queues and posts them as Log Events to the Log API. The diagram shows every host involved, with the agent on its own server; each arrow starts at the side that opens the connection.

graph LR subgraph "Nodinite Core Services Server" roLogAPI(fa:fa-cloud-arrow-down Log API) end subgraph "Nodinite Agent Server" roPS(fa:fa-truck-pickup IBM Integration Bus Logging Agent) end subgraph "Target: IBM MQ Server" roQM(fa:fa-list Queue Manager with IIB event queues) end subgraph "DNS Server" roDNS(fa:fa-signs-post DNS) end roPS --> |"1414"| roQM roPS --> |"Log API site port"| roLogAPI roPS --> |"53"| roDNS

Network diagram: the agent reads Monitoring Events from the Queue Manager and posts Log Events to the Log API. The legacy agent is configured with a local Settings.json file, so the Monitoring Service never calls it.

Note

When the agent runs on the Core Services Server (the recommended installation), you need no firewall rule between the agent and the Log API. The replacement, IBM Integration Bus Logging in the IBM MQ Monitoring Agent, has its own firewall settings.

Between the IBM Integration Bus Logging Agent and the IBM MQ Queue Managers

The agent connects to the Queue Managers to consume messages from the IIB log queues.

Direction Source Destination Protocol Port(s) Purpose Notes
Outbound Agent Server Target (IBM MQ Server) TCP 1414 IBM MQ Listener Default MQ listener port; each Queue Manager can use its own port (set it in the agent's Queue Manager connection settings). TLS uses the same port
Inbound Target (IBM MQ Server) Agent Server TCP 1414 Response traffic Automatically allowed by stateful firewall inspection

Tip

IBM MQ Client: The agent requires IBM MQ Client libraries (v7.5 to v9.2) installed on the Agent Server. Match the IBM MQ Client version with the highest version of IBM MQ used with IBM Integration Bus. See IBM MQ Client downloads.

Tip

SSL/TLS Configuration: For secure MQ connections, configure SSL/TLS with mutual authentication. Ensure the Agent Server trusts the MQ server's SSL certificate and has a valid client certificate if required. See IBM MQ security documentation for details.

Tip

MSDTC for XA Transactions: The agent requires MSDTC (Microsoft Distributed Transaction Coordinator) configured with XA transactions enabled for transactional message consumption. See MSDTC configuration guide for details.

Tip

Monitor Log Queues: Use the Nodinite IBM MQ Monitoring Agent to monitor the IBM Integration Bus log queues for depth, age, and other metrics.

Between the IBM Integration Bus Logging Agent and the Log API

Direction Source Destination Protocol Port(s) Purpose Notes
Outbound Agent Server Core Services Server TCP (HTTPS/HTTP) Log API site port Post Log Events to the Log API (the LogAPI setting, for example https://nodinitesrv01:40002/LogAPI/) v7. The Log API is its own IIS web site; port set per environment in the Nodinite Portal (Servers step). Use HTTPS when the Log API is not on localhost

Between the servers and DNS

Direction Source Destination Protocol Port(s) Purpose Notes
Outbound Agent Server DNS Server TCP/UDP 53 Name resolution Resolve the Queue Managers and the Core Services Server. A local hosts file can replace DNS

Important

Stateful Firewalls: Most Windows Firewall implementations are stateful, so response traffic for established outbound connections is allowed automatically. The inbound response rules above are for reference and troubleshooting.


Frequently asked questions

Additional solutions to common problems and the FAQ for the Nodinite IBM Integration Bus Logging Agent exist in the Troubleshooting user guide.

Next Steps

Install IBM Integration Bus Logging Agent
Administration

Log Agents
LogAPI