Custom Connector for enabling logging from Mule ESB

Use the Nodinite Custom connector instead of a Logger and/or Business Events shape for enabling logging from Mule ESB on-premise and/or in the cloud!

Supported versions:

• 3.9
• 3.8
• 3.7
• 3.6

For Mulesoft run-time 4 and later, you will need to invent the custom connector on your own.

The Nodinite Custom connector is intended to be used as a template to help get you started quickly.

Example illustration of using the Nodinite logging custom connector with Mule ESB flows.

Example usage of the Nodinite custom connector for Mule ESB flows.

To enable logging from your Mule ESB flows, simply add the Nodinite Custom Connector (Prefixed Log ... in the examples). You should use the Nodinite Custom connector instead of the Logger or Business events shapes.

How do I get started with logging from Mule ESB using the Nodinite custom connector?

First, make sure you have read the Asynchronous Logging user guide and have the Pickup Service installed

Step 1: Download the Nodinite Custom Connector

From the Nodinite portal first download the zip file with the Nodinite custom connector

Step 2: Add Custom Connector to Anypoint Studio

Simply add the ZIP file to your Anypoint studio. The end result should look something like the following image:

Anypoint Studio 6
Here's an example of Nodinite Custom connector when added to Anypoint studio

Anypoint Studio 7 Import Jar package

Step 3: Add Custom Connector to Flow

From within your Mule ESB Flows add the Nodinite logging custom connector where applicable (before and after transformation, exception handling, conditional flows, sub flows, ...)

Step 4: Code for Target destination

Logging is implemented as a generic reusable sub flow:

Here's an example of logging sub flow

The logging sub flow creates the JSON Log Event and posts it to some destination like one of the following:

You must make a decision on which one to use. If you want to change destination with this approach you should only need to change it in exactly one; the one only location.

Step 5: Configure Pickup Service

The Pickup Service fetches your JSON Log Events from the destination you coded for in the previous step.

Step 6: Verify and fine-tune

Your last step now is to verify and fine-tune logging according to your business needs.

Tuning and best practices

Make sure to start easy and implement the use of the Custom Connector with a few Mule ESB flows before adding it everywhere.

The following event fields are mandatory and the rest of the fields are optional (set value to null or do not provide the field at all). By providing additional details about the Log Event, end-users may have a better user experience with Nodinite.

Review the Json Log Event user guide for full details.

Exception handling

Make sure to add the custom connector to your exception handling and set the Log Status Code according to your business case. The use of Log Status Codes is very flexible and provides the option for user-friendly texts for the business according to your own logic.

Correlation

Review the Mule ESB Correlation user guide.

Message Types

Providing the Message Type is mandatory.

Many of the Nodinite logging features depends on well known Message Types. For example when extracting values for Search Fields Nodinite uses Search Field Expressions and these are bound to named Message Types.

Tip

Make sure to provide unique names for message types to have the best logging experience with Nodinite

Context Options

Nodinite provides a plethora of logging options. Review the Context Options user guide for more information.

Repair and resubmit

Using the Context Options you can add properties to the logged JSON Log Events that Nodinite can use when repairing and resubmitting messages. Make sure to build your Mule ESB flows with a way to receive and deal with resubmitted messages.

Log Views

Make sure to involve your business and create role based self-service Log Views. Doing so will result in less incidents and a business that gets a better understanding for system integration solutions.

Next Step

How to Add or manage Search Fields
How to Add or manage Log Views

Related

• Logging
• Log Events
• What are Search Fields?
• What are Search Field Expressions?
• What are Message Types?
• What are Log Views?

Example flow configuration using the downloadable Nodinite custom connector

<?xml version="1.0" encoding="UTF-8"?>

<mule xmlns:nodinite="http://www.mulesoft.org/schema/mule/nodinite" xmlns:http="http://www.mulesoft.org/schema/mule/http" xmlns:scripting="http://www.mulesoft.org/schema/mule/scripting" xmlns:file="http://www.mulesoft.org/schema/mule/file" xmlns:json="http://www.mulesoft.org/schema/mule/json" xmlns:batch="http://www.mulesoft.org/schema/mule/batch" xmlns:tracking="http://www.mulesoft.org/schema/mule/ee/tracking" xmlns="http://www.mulesoft.org/schema/mule/core" xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
	xmlns:spring="http://www.springframework.org/schema/beans" 
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-current.xsd
http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd
http://www.mulesoft.org/schema/mule/file http://www.mulesoft.org/schema/mule/file/current/mule-file.xsd
http://www.mulesoft.org/schema/mule/ee/tracking http://www.mulesoft.org/schema/mule/ee/tracking/current/mule-tracking-ee.xsd
http://www.mulesoft.org/schema/mule/json http://www.mulesoft.org/schema/mule/json/current/mule-json.xsd
http://www.mulesoft.org/schema/mule/batch http://www.mulesoft.org/schema/mule/batch/current/mule-batch.xsd
http://www.mulesoft.org/schema/mule/scripting http://www.mulesoft.org/schema/mule/scripting/current/mule-scripting.xsd
http://www.mulesoft.org/schema/mule/http http://www.mulesoft.org/schema/mule/http/current/mule-http.xsd
http://www.mulesoft.org/schema/mule/nodinite http://www.mulesoft.org/schema/mule/nodinite/current/mule-nodinite.xsd">
    <spring:beans>
        <spring:bean class="int001.filemove.transform.NodiniteLoggerService" name="CreateLogEventBean"/>
    </spring:beans>
    <http:request-config name="Nodinite_HTTP_Request_Configuration" host="demo.nodinite.com" port="80" basePath="/LogAPI/api/" doc:name="HTTP Request Configuration"/>
    <nodinite:config name="Nodinite__Configuration"  doc:name="Nodinite: Configuration"/>
    <flow name="int001.filemove.transformFlow">
        <file:inbound-endpoint path="C:\Temp\mule\int001.filemove.transform\in\" responseTimeout="10000" doc:name="File"/>
        <byte-array-to-string-transformer doc:name="Byte Array to String"/>
        <scripting:component doc:name="Groovy - set up logging variables">
            <scripting:script engine="Groovy"><![CDATA[sessionVars['correlationId'] = message.id;

message.correlationId = sessionVars['correlationId'];

sessionVars['nodiniteMessageTypeName'] = "MuleOrderBatch#1.0";
sessionVars['nodiniteLogText'] = "File Received";
sessionVars['nodiniteLogStatus'] = 0;
sessionVars['nodiniteEndPointDirection'] = 0;

sessionVars['nodiniteContextValues'] = [receivedFileName: flowVars['originalFilename']];

return payload;]]></scripting:script>
        </scripting:component>
        <logger message="Logging Correlation Id: #[sessionVars.correlationId]" level="INFO" doc:name="Logger"/>
        <flow-ref name="int001.filemove.nodiniteloggingflow" doc:name="Log"/>
        <choice doc:name="Choice">
            <when expression="flowVars.originalFilename.endsWith('.json')">
                <scripting:component doc:name="Update logging vars before looping">
                    <scripting:script engine="Groovy"><![CDATA[message.correlationId = sessionVars['correlationId'];

sessionVars['nodiniteMessageTypeName'] = "MuleOrderBatch#1.0";
sessionVars['nodiniteLogText'] = "Starting to debatch file";
sessionVars['nodiniteLogStatus'] = 0;
sessionVars['nodiniteEndPointDirection'] = 0;

sessionVars['nodiniteContextValues'] = [receivedFileName: flowVars['originalFilename']];

return payload;]]></scripting:script>
                </scripting:component>
                <flow-ref name="int001.filemove.nodiniteloggingflow" doc:name="Log Before Processing"/>
                <json:object-to-json-transformer mimeType="application/json" doc:name="Object to JSON"/>
                <json:json-to-object-transformer returnClass="java.util.List" doc:name="JSON to Object"/>
                <foreach collection="#[payload]" doc:name="For Each">
                    <flow-ref name="int0int001.filemove.processSingleOrder" doc:name="processOrder"/>
                </foreach>
            </when>
            <otherwise>
                <scripting:component doc:name="Update logging variables">
                    <scripting:script engine="Groovy"><![CDATA[sessionVars['nodiniteMessageTypeName'] = "Unknown";
sessionVars['nodiniteLogText'] = "Message extension is wrong - should be JSON.";
sessionVars['nodiniteLogStatus'] = -1;
sessionVars['nodiniteEndPointDirection'] = 0;

sessionVars['nodiniteContextValues'] = [receivedFileName: "#[flowVars.originalFileName]"];

return payload;]]></scripting:script>
                </scripting:component>
                <flow-ref name="int001.filemove.nodiniteloggingflow" doc:name="Log error message"/>
                <file:outbound-endpoint path="C:\Temp\mule\int001.filemove.transform\invalid\" outputPattern="#[flowVars.originalFilename]" responseTimeout="10000" doc:name="MoveToInvalidFolder"/>
            </otherwise>
        </choice>
    </flow>
    <sub-flow name="int0int001.filemove.processSingleOrder">
        <set-variable variableName="currentOrderId" value="#[payload.OrderId]" doc:name="Variable"/>
        <json:object-to-json-transformer doc:name="Object to JSON"/>
        <scripting:component doc:name="Before processing">
            <scripting:script engine="Groovy"><![CDATA[message.correlationId = sessionVars['correlationId'];

sessionVars['nodiniteMessageTypeName'] = "MuleOrder#1.0";
sessionVars['nodiniteLogText'] = "Starting to process order";
sessionVars['nodiniteLogStatus'] = 0;
sessionVars['nodiniteEndPointDirection'] = 0;

sessionVars['nodiniteContextValues'] = [receivedFileName: flowVars['originalFilename'], orderId: flowVars.currentOrderId.toString(), isGDPRData: "true"];

return payload;]]></scripting:script>
        </scripting:component>
        <flow-ref name="int001.filemove.nodiniteloggingflow" doc:name="Log single order"/>
        <file:outbound-endpoint path="C:\Temp\mule\int001.filemove.transform\out" outputPattern="#[flowVars.currentOrderId].json" responseTimeout="10000" doc:name="File"/>
        <scripting:component doc:name="After processing">
            <scripting:script engine="Groovy"><![CDATA[message.correlationId = sessionVars['correlationId'];

sessionVars['nodiniteMessageTypeName'] = "MuleOrder#1.0";
sessionVars['nodiniteLogText'] = "Done processing order";
sessionVars['nodiniteLogStatus'] = 0;
sessionVars['nodiniteEndPointDirection'] = 1;

sessionVars['nodiniteContextValues'] = [receivedFileName: flowVars['originalFilename'], orderId: flowVars['currentOrderId'].toString(), outFullName: "C:\\Temp\\mule\\int001.filemove.transform\\out\\" + flowVars['currentOrderId'].toString() + ".json", outDirectory: "C:\\Temp\\mule\\int001.filemove.transform\\out\\", outFileName: flowVars['currentOrderId'].toString() + ".json"];

return payload;]]></scripting:script>
        </scripting:component>
        <flow-ref name="int001.filemove.nodiniteloggingflow" doc:name="Log done single order"/>
    </sub-flow>
    <sub-flow name="int001.filemove.nodiniteloggingflow">
        <logger message="#[sessionVars.nodiniteLogText]" level="INFO" doc:name="Logger"/>
        <set-variable variableName="payloadBeforeNodiniteLogEvent" value="#[payload]" doc:name="Variable"/>
        <nodinite:create-log-event config-ref="Nodinite__Configuration" endPointName="int001.filemove.transformFlow" endpointUri="mule.developer" endPointDirection="#[sessionVars.nodiniteEndPointDirection]" originalMessageTypeName="#[sessionVars.nodiniteMessageTypeName]" logStatus="#[sessionVars.nodiniteLogStatus]" logText="#[sessionVars.nodiniteLogText]" payload="#[payload]" doc:name="Nodinite" processMachineName="roma.dev" processModuleName="int001.filemove.nodiniteloggingflow" processModuleType="Mule Flow" processName="int001.filemove.transformFlow">
            <nodinite:context-properties ref="#[sessionVars.nodiniteContextValues]"/>
        </nodinite:create-log-event>
        <http:request config-ref="Nodinite_HTTP_Request_Configuration" path="logEvent/logEvent" method="POST" doc:name="HTTP">
            <http:request-builder>
                <http:header headerName="Content-Type" value="application/json"/>
            </http:request-builder>
        </http:request>
        <set-payload value="#[flowVars.payloadBeforeNodiniteLogEvent]" doc:name="Set Payload"/>
    </sub-flow>
</mule>