Goal is provide a xml/json that collects business process execution, so allow us know if everything went right or wrong?, what activities have taken place?, how long have taken something?, what messages have been exchanged, etc. Giving the possibility to include information that allows us to perform a forensic analysis of the business process or even reactivate it if necessary.
How to generate this in our WSO2 ESB projects? We can write the XML by hand within the sequences, but it's complicated and less than optimal. the ideal would be have a "mediator" in charge of performing this function in the most optimal way possible. This is the Mediator Audit. The Audit Mediator introduces new xml tags inspired by BPMN (TaskAudit, reveiveTaskAudit, sendTaskAudit,subProcessAudit, serialize, etc), to be used within the proxies and Sequences, which facilitates the generation of xml audit.
- Audit and system logs.
- Common data model to facilitate the implementation of EIPs as Dead Letter Pattern channel, invalid message channel.
- Process coordination, etc.
- Definition of XML, using as a basis BPMN. See businessProcessAudit.xsd for a description of xml
- Created a mediator for wso2 esb, to facilitate the generation of XML audit within the ESB, Project AuditMediator. See audit_mediator_XML_interface.xml and auditMediator.xsd for a description of the Audit Mediator Xml commands.
- UI for easy editing of tags within Proxies and Sequences. Note: XML code assist is possible by auditMediator.xsd
- Increase the number of BPMN tags supported (events, conversations) and implementations (ftp, imap, cifs, etc) within the activities
Wiki https://github.com/manueltoscanoferrera/BPMN-audit-mediator-for-WSO2-ESB/wiki
This xml describes in detail the execution of a business process. It is the element that we want to generated easily with the Audit Mediator.
<businessProcessAudit xmlns="urn:org:codigolibre:businessprocessaudit:type:v1.0.0">
<id>52</id>
<name>Consulta Demanda Por ID Abreviada</name>
<description>Consulta Demanda Por ID Abreviada</description>
<startTime>2015-04-29T12:07:43.664+02:00</startTime>
<endTime>2015-04-29T12:07:43.669+02:00</endTime>
<status>OK</status>
<activities>
<receiveTaskAudit>
<id>ProxyPruebas</id>
<name>prueba</name>
<description>echo</description>
<startTime>2015-04-29T12:07:43.665+02:00</startTime>
<endTime>2015-04-29T12:07:52.422+02:00</endTime>
<status>OK</status>
<webServiceAudit>
<endPoint>local:///services/prueba.pruebaLocalSoap11Endpoint/</endPoint>
<operation>urn:echoString</operation>
<type>SOAP</type>
<msgRequest><?xml version="1.0" encoding="utf-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:echo="http://echo.services.core.carbon.wso2.org"><soapenv:Header xmlns:wsa="http://www.w3.org/2005/08/addressing"><wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"><wsse:UsernameToken wsu:Id="UsernameToken-8"><wsse:Username>admin</wsse:Username><wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">admin</wsse:Password><wsse:Nonce EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary">2dSnL+J7dRketCGOGUrM8w==</wsse:Nonce><wsu:Created>2015-04-29T10:07:51.486Z</wsu:Created></wsse:UsernameToken><wsu:Timestamp wsu:Id="TS-7"><wsu:Created>2015-04-29T10:07:51.486Z</wsu:Created><wsu:Expires>2015-04-29T10:08:01.486Z</wsu:Expires></wsu:Timestamp></wsse:Security><wsa:Action>urn:echoString</wsa:Action><wsa:MessageID>1111</wsa:MessageID></soapenv:Header><soapenv:Body> <echo:echoString> <!--Optional:--> <in>qwwqw</in> </echo:echoString> </soapenv:Body></soapenv:Envelope></msgRequest>
<msgResponse><?xml version="1.0" encoding="utf-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"><soapenv:Body><ns:echoStringResponse xmlns:ns="http://echo.services.core.carbon.wso2.org"><return>qwwqw</return></ns:echoStringResponse></soapenv:Body></soapenv:Envelope></msgResponse>
<ipClient>127.0.1.1</ipClient>
<hostClient>usuario-laptop7</hostClient>
<idClient>admin</idClient>
<ipServer>127.0.1.1</ipServer>
<hostServer>usuario-laptop7</hostServer>
</webServiceAudit>
</receiveTaskAudit>
<sendTaskAudit>
<id>callWSConsultaDemandaPorID</id>
<name>Consulta Demanda Por ID</name>
<description>echo</description>
<startTime>2015-04-29T12:07:43.667+02:00</startTime>
<endTime>2015-04-29T12:07:52.418+02:00</endTime>
<status>OK</status>
<webServiceAudit>
<endPoint>http://usuario-laptop7:8280/services/echo</endPoint>
<operation>echoString</operation>
<type>SOAP</type>
<idMsg>urn:uuid:7938c7ca-0195-4954-9017-5934b22bb83f</idMsg>
<msgRequest><?xml version="1.0" encoding="utf-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:echo="http://echo.services.core.carbon.wso2.org"><soapenv:Header xmlns:wsa="http://www.w3.org/2005/08/addressing"><wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"><wsse:UsernameToken wsu:Id="UsernameToken-8"><wsse:Username>admin</wsse:Username><wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">admin</wsse:Password><wsse:Nonce EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary">2dSnL+J7dRketCGOGUrM8w==</wsse:Nonce><wsu:Created>2015-04-29T10:07:51.486Z</wsu:Created></wsse:UsernameToken><wsu:Timestamp wsu:Id="TS-7"><wsu:Created>2015-04-29T10:07:51.486Z</wsu:Created><wsu:Expires>2015-04-29T10:08:01.486Z</wsu:Expires></wsu:Timestamp></wsse:Security><wsa:Action>urn:echoString</wsa:Action><wsa:MessageID>1111</wsa:MessageID></soapenv:Header><soapenv:Body> <echo:echoString> <!--Optional:--> <in>qwwqw</in> </echo:echoString> </soapenv:Body></soapenv:Envelope></msgRequest>
<msgResponse><?xml version="1.0" encoding="utf-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"><soapenv:Body><ns:echoStringResponse xmlns:ns="http://echo.services.core.carbon.wso2.org"><return>qwwqw</return></ns:echoStringResponse></soapenv:Body></soapenv:Envelope></msgResponse>
<ipClient>127.0.1.1</ipClient>
<hostClient>usuario-laptop7</hostClient>
<ipServer>127.0.1.1</ipServer>
<hostServer>usuario-laptop7</hostServer>
</webServiceAudit>
</sendTaskAudit>
</activities>
</businessProcessAudit>
This JSON describes in detail the execution of a business process. It is the element that we want to generated easily with the Audit Mediator.
{
"businessProcessAudit":{
"id":52,
"name":"Consulta Demanda Por ID Abreviada",
"description":"Consulta Demanda Por ID Abreviada",
"startTime":"2015-04-29T14:25:27.135+02:00",
"endTime":"2015-04-29T14:25:27.139+02:00",
"status":"OK",
"activities":{
"receiveTaskAudit":{
"id":"ProxyPruebas",
"name":"prueba",
"description":"echo",
"startTime":"2015-04-29T14:25:27.137+02:00",
"endTime":"2015-04-29T14:25:40.564+02:00",
"status":"OK",
"webServiceAudit":{
"endPoint":"local:\/\/\/services\/prueba.pruebaLocalSoap11Endpoint\/",
"operation":"urn:echoString",
"type":"SOAP",
"msgRequest":"<?xml version=\"1.0\" encoding=\"utf-8\"?><soapenv:Envelope xmlns:soapenv=\"http:\/\/schemas.xmlsoap.org\/soap\/envelope\/\" xmlns:echo=\"http:\/\/echo.services.core.carbon.wso2.org\"><soapenv:Header xmlns:wsa=\"http:\/\/www.w3.org\/2005\/08\/addressing\"><wsse:Security xmlns:wsse=\"http:\/\/docs.oasis-open.org\/wss\/2004\/01\/oasis-200401-wss-wssecurity-secext-1.0.xsd\" xmlns:wsu=\"http:\/\/docs.oasis-open.org\/wss\/2004\/01\/oasis-200401-wss-wssecurity-utility-1.0.xsd\"><wsse:UsernameToken wsu:Id=\"UsernameToken-10\"><wsse:Username>admin<\/wsse:Username><wsse:Password Type=\"http:\/\/docs.oasis-open.org\/wss\/2004\/01\/oasis-200401-wss-username-token-profile-1.0#PasswordText\">admin<\/wsse:Password><wsse:Nonce EncodingType=\"http:\/\/docs.oasis-open.org\/wss\/2004\/01\/oasis-200401-wss-soap-message-security-1.0#Base64Binary\">3pREDougGrk\/xZjhNJpMiA==<\/wsse:Nonce><wsu:Created>2015-04-29T12:25:37.816Z<\/wsu:Created><\/wsse:UsernameToken><wsu:Timestamp wsu:Id=\"TS-9\"><wsu:Created>2015-04-29T12:25:37.816Z<\/wsu:Created><wsu:Expires>2015-04-29T12:25:47.816Z<\/wsu:Expires><\/wsu:Timestamp><\/wsse:Security><wsa:Action>urn:echoString<\/wsa:Action><wsa:MessageID>1111<\/wsa:MessageID><\/soapenv:Header><soapenv:Body>\n <echo:echoString>\n <!--Optional:-->\n <in>qwwqw<\/in>\n <\/echo:echoString>\n <\/soapenv:Body><\/soapenv:Envelope>",
"msgResponse":"<?xml version=\"1.0\" encoding=\"utf-8\"?><soapenv:Envelope xmlns:soapenv=\"http:\/\/schemas.xmlsoap.org\/soap\/envelope\/\"><soapenv:Body><ns:echoStringResponse xmlns:ns=\"http:\/\/echo.services.core.carbon.wso2.org\"><return>qwwqw<\/return><\/ns:echoStringResponse><\/soapenv:Body><\/soapenv:Envelope>",
"ipClient":"127.0.1.1",
"hostClient":"usuario-laptop7",
"idClient":"admin",
"ipServer":"127.0.1.1",
"hostServer":"usuario-laptop7"
}
},
"sendTaskAudit":{
"id":"callWSConsultaDemandaPorID",
"name":"Consulta Demanda Por ID",
"description":"echo",
"startTime":"2015-04-29T14:25:27.138+02:00",
"endTime":"2015-04-29T14:25:40.555+02:00",
"status":"OK",
"webServiceAudit":{
"endPoint":"http:\/\/usuario-laptop7:8280\/services\/echo",
"operation":"echoString",
"type":"SOAP",
"idMsg":"urn:uuid:2edafcaa-01c9-456b-8c5d-f3f3689d8dbb",
"msgRequest":"<?xml version=\"1.0\" encoding=\"utf-8\"?><soapenv:Envelope xmlns:soapenv=\"http:\/\/schemas.xmlsoap.org\/soap\/envelope\/\" xmlns:echo=\"http:\/\/echo.services.core.carbon.wso2.org\"><soapenv:Header xmlns:wsa=\"http:\/\/www.w3.org\/2005\/08\/addressing\"><wsse:Security xmlns:wsse=\"http:\/\/docs.oasis-open.org\/wss\/2004\/01\/oasis-200401-wss-wssecurity-secext-1.0.xsd\" xmlns:wsu=\"http:\/\/docs.oasis-open.org\/wss\/2004\/01\/oasis-200401-wss-wssecurity-utility-1.0.xsd\"><wsse:UsernameToken wsu:Id=\"UsernameToken-10\"><wsse:Username>admin<\/wsse:Username><wsse:Password Type=\"http:\/\/docs.oasis-open.org\/wss\/2004\/01\/oasis-200401-wss-username-token-profile-1.0#PasswordText\">admin<\/wsse:Password><wsse:Nonce EncodingType=\"http:\/\/docs.oasis-open.org\/wss\/2004\/01\/oasis-200401-wss-soap-message-security-1.0#Base64Binary\">3pREDougGrk\/xZjhNJpMiA==<\/wsse:Nonce><wsu:Created>2015-04-29T12:25:37.816Z<\/wsu:Created><\/wsse:UsernameToken><wsu:Timestamp wsu:Id=\"TS-9\"><wsu:Created>2015-04-29T12:25:37.816Z<\/wsu:Created><wsu:Expires>2015-04-29T12:25:47.816Z<\/wsu:Expires><\/wsu:Timestamp><\/wsse:Security><wsa:Action>urn:echoString<\/wsa:Action><wsa:MessageID>1111<\/wsa:MessageID><\/soapenv:Header><soapenv:Body>\n <echo:echoString>\n <!--Optional:-->\n <in>qwwqw<\/in>\n <\/echo:echoString>\n <\/soapenv:Body><\/soapenv:Envelope>",
"msgResponse":"<?xml version=\"1.0\" encoding=\"utf-8\"?><soapenv:Envelope xmlns:soapenv=\"http:\/\/schemas.xmlsoap.org\/soap\/envelope\/\"><soapenv:Body><ns:echoStringResponse xmlns:ns=\"http:\/\/echo.services.core.carbon.wso2.org\"><return>qwwqw<\/return><\/ns:echoStringResponse><\/soapenv:Body><\/soapenv:Envelope>",
"ipClient":"127.0.1.1",
"hostClient":"usuario-laptop7",
"ipServer":"127.0.1.1",
"hostServer":"usuario-laptop7"
}
}
}
}
}
In this example we use the audit mediators commands within a ESB proxy to generate a detailed XML than describe the proxy execution. Also shows how to implement the Dead Letter Channel EIP using the Audit Mediator.
<?xml version="1.0" encoding="UTF-8"?>
<proxy xmlns="http://ws.apache.org/ns/synapse"
name="prueba"
transports="https http"
startOnLoad="true"
trace="enable">
<description/>
<target>
<endpoint>
<address uri="http://usuario-laptop7:8280/services/echo"/>
</endpoint>
<inSequence>
<audit>
<businessProcess id="52">
<name value="Consulta Demanda Por ID Abreviada"/>
<description value="Consulta Demanda Por ID Abreviada"/>
</businessProcess>
<receiveTask id="ProxyPruebas" new="true">
<webService>
<msgRequest capture="true"/>
</webService>
</receiveTask>
<sendTask id="callWSConsultaDemandaPorID" new="true">
<name value="Consulta Demanda Por ID"/>
<webService>
<msgRequest capture="true"/>
</webService>
</sendTask>
</audit>
</inSequence>
<outSequence>
<audit>
<businessProcess closeWithStatus="OK" cascadeClose="true" captureMsg="true">
<status value="OK"/>
</businessProcess>
<serialize store="audit_store" media-type="xml"/>
</audit>
<send/>
</outSequence>
<faultSequence>
<makefault version="soap11">
<code xmlns:tns="http://www.w3.org/2003/05/soap-envelope" value="tns:Receiver"/>
<reason expression="get-property('ERROR_MESSAGE')"/>
</makefault>
<audit>
<businessProcess closeWithStatus="ERROR" cascadeClose="true" captureMsg="true"/>
<serialize store="dead_letter_channel" media-type="xml"/>
</audit>
<respond/>
</faultSequence>
</target>
<publishWSDL uri="http://usuario-laptop7:8280/services/echo?wsdl"/>
<policy key="conf:/repository/axis2/service-groups/prueba/services/prueba/policies/UTOverTransport"/>
<parameter name="ScenarioID">scenario1</parameter>
<enableSec/>
</proxy>