- 6 minutes to read

Prerequisites for the Nodinite Mule ESB Logging agent

Unlock seamless integration and powerful monitoring by preparing your environment for the Nodinite Mule ESB Logging Agent. This guide covers everything you need for a successful installation and operation.

graph LR subgraph "Nodinite Instance" roNI(fal:fa-monitor-waveform Mule ESB Logging Agent) end subgraph "Anypoint instances in the cloud" roCloudhubAPI(fal:fa-cloud Cloudhub API)-->roIS(fal:fa-database Internal storage) roNI --> |API| roCloudhubAPI roFlow2(fal:fa-sitemap Flow) -->|Log4J| roIS end subgraph "Mule ESB instance on-premise" roFolder(fal:fa-folder Folder) roNI --> |SMB| roFolder roFlow(fal:fa-sitemap Flow) --> |Log4J| roFolder end
*Architecture overview: The Nodinite Mule ESB Logging Agent supports both on-premise and cloud-based MuleSoft environments.*

We recommend installing this agent close to your Nodinite Core Services. This documentation covers local network setup (usually on the Nodinite application server).

Verified Topic
Software Requirements
What folder rights does the Mule ESB Logging Agent require?
What Anypoint Cloudhub rights does the Mule ESB Logging Agent require?
What Windows User Rights does the Mule ESB Logging Agent require?
What Firewall settings are required for the Mule ESB Logging Agent?

Software Requirements

The Mule ESB Logging Agent is a Windows Service and is usually installed on the Nodinite application server.

Product
Windows Server Windows 2025
Windows 2022
Windows 2019
Windows 2016
Windows 2012 R2
Windows 2012
.NET Framework .NET Framework 4.5 or later

Supported Versions

Cloud technologies evolve rapidly, and MuleSoft deprecates older API versions regularly. Nodinite always supports the APIs supported by MuleSoft. Update Nodinite and the Mule ESB Logging Agent as needed to stay current.

Subscribe to our Release Notes to stay informed about updates.

What folder rights does the Mule ESB Logging Agent require?

If you use Mule ESB on-premise with the Log4J file appender, logged events are created on local disk or a Windows File share (SMB).
The Mule ESB Logging Agent must have Read, Write, and Change permissions to consume these events.

What Anypoint Cloudhub rights does the Mule ESB Logging Agent require?

  • The agent uses the MuleSoft Anypoint Cloudhub API to read logged events with tracked properties. Grant the agent the necessary access rights as described in the Configuration.

What Windows User Rights does the Mule ESB Logging Agent require?

The agent is installed as a Windows Service, usually on the Nodinite application server. Virtual machines are supported.

What Firewall settings are required for the Mule ESB Logging Agent?

The Mule ESB Logging Agent requires both inbound and outbound communication:

  1. Between the Mule ESB Logging Agent and SMB File share or folder
  2. Between the Mule ESB Logging Agent and Cloudhub API
  3. Between the Mule ESB Logging Agent and the Log API
graph LR subgraph "Nodinite Instance" roNI(fal:fa-monitor-waveform Mule ESB Logging Agent) end subgraph "Anypoint instances in the cloud" roCloudhubAPI(fal:fa-cloud Cloudhub API)-->roIS(fal:fa-database Internal storage) roNI --> |443| roCloudhubAPI end subgraph "Mule ESB instance on-premise" roFolder(fal:fa-folder Folder or SMB File share) roNI --> |135-139, 445,...| roFolder end
*Network communication overview for the Mule ESB Logging Agent.*

1. Between the Mule ESB Logging Agent and On-Premise Mule ESB

Server types: Agent Server (Mule ESB Logging Agent), Mule Server (on-premise Mule ESB runtime with log file shares).

SMB File Share Connection (Agent → Mule ESB Log Files)

The agent uses SMB protocol to access log files from on-premise Mule ESB instances.

Direction Source Destination Protocol Port(s) Purpose Notes
Outbound Agent Server Mule Server (SMB) TCP/UDP 135-139 Microsoft file sharing (NetBIOSS) Legacy SMB over NetBIOS
Outbound Agent Server Mule Server (SMB) TCP/UDP 445 Direct-hosted SMB traffic Modern SMB protocol (SMB 2/3)
Inbound Mule Server (SMB) Agent Server TCP/UDP 135-139, 445 Response traffic Allowed automatically by stateful firewalls

Tip

SMB Versions: Port 445 is used by SMB 2.0 and SMB 3.0 (recommended for security and performance). Ports 135-139 support older SMB 1.0/CIFS for legacy compatibility. Consider disabling SMB 1.0 for security.

Tip

SMB Permissions: Ensure the agent service account has Read permissions on the Mule ESB log file folders. See SMB: File and printer sharing ports should be open and Internet firewalls can prevent browsing and file sharing for details.

2. Between the Mule ESB Logging Agent and MuleSoft Cloudhub API

Server types: Agent Server (Mule ESB Logging Agent), Cloudhub Cloud (MuleSoft Anypoint Cloudhub API).

Cloudhub API Connection (Agent → Cloudhub Cloud)

The agent connects to the MuleSoft Cloudhub API to retrieve logged events with tracked properties from cloud-hosted Mule ESB instances.

Direction Source Destination Protocol Port(s) Purpose Notes
Outbound Agent Server Cloudhub Cloud (API) TCP 443 (HTTPS) Cloudhub API communication Retrieve cloud-hosted Mule logs
Inbound Cloudhub Cloud Agent Server TCP 443 (HTTPS) Response traffic Allowed automatically by stateful firewalls

Tip

Cloudhub Authentication: The agent uses the MuleSoft Anypoint Cloudhub API with appropriate access rights. Ensure the account has permissions to read logged events and tracked properties. See Configuration for details.

Tip

Hybrid Deployment: The agent supports both on-premise Mule ESB (via SMB) and cloud-hosted Mule ESB (via Cloudhub API) simultaneously. Configure firewall rules for both sections 1 and 2 if monitoring hybrid deployments.

Note

No Inbound Rules on Cloudhub: MuleSoft Cloudhub is a cloud service accessed outbound from the Agent Server. No inbound firewall rules are required on the Cloudhub side.

3. Between the Mule ESB Logging Agent and Nodinite Log API

Server types: Agent Server (Mule ESB Logging Agent), Nodinite Server (Log API).

Log API Connection (Agent → Nodinite Log API)

When logging is enabled, the agent sends log events to the Nodinite Log API for storage and analysis.

Direction Source Destination Protocol Port(s) Purpose Notes
Outbound Agent Server Nodinite Server (Log API) TCP 80 (HTTP), 443 (HTTPS) Log event submission Agent posts log events to Nodinite
Inbound Nodinite Server Agent Server TCP 80 (HTTP), 443 (HTTPS) Response traffic Allowed automatically by stateful firewalls

Tip

Local Server Performance: If the Mule ESB Logging Agent and Log API are on the same server, use HTTP (port 80) for best performance and security (loopback traffic).

Tip

HTTPS Recommended: For production environments with the agent and Log API on different servers, configure the Log API to use HTTPS (port 443) with valid SSL/TLS certificates to encrypt log data in transit.

Note

DNS Resolution: All servers (Agent Server, Mule Server, Nodinite Server) require outbound access to DNS on TCP/UDP port 53 for name resolution. You can optionally solve this using entries in the local hosts file on each server.

Important

Stateful Firewalls: Most modern Windows Firewall implementations are stateful, meaning inbound response traffic for established outbound connections is automatically allowed. The inbound rules listed above are primarily for reference and troubleshooting scenarios where stateful inspection may be disabled or restricted.


Frequently asked questions

Find solutions to common problems and FAQs for the Nodinite Mule ESB Logging Agent in the Troubleshooting user guide.

About Mule ESB

  • Anypoint Studio 6 requires Java8

Next Step

Add or manage a Monitoring Agent Configuration
Install the Mule ESB Logging Agent

Administration
Monitoring Agents