This is a tech preview feature introduced in v1.0.5. When used, a syslog record will be sent for each DataPower transaction.
The syslog record used is a json-formatted data object, containing information aggregated from several sources relating to the transaction.
The feature requires DataPower FW 7.6+
Value to Customers
- This feature allows customers to easily display DataPower information on their APMs or log aggregator such as IBM APMs , Splunk or ELK. This removes the dependency on, and isolates the customer from changes to DataPower's log structure.
- Customers may add a link to the syslog record, which redirects from each transaction into DPOD' transaction details, in order to enhance troubleshooting efforts.
- DPOD customers can use this feature to externalize DPOD information for Data Warehouse purposes.
- DPOD customers can retain summarized transaction details. This will increase history information retention time period and minimize storage requirements.
Transaction Record Structure
The following table describes the fields that are logged with this feature.
| Field Name | Description | Possible Values |
|---|---|---|
| deviceName | DataPower device name | String |
| domainName | DataPower domain name where the transaction was executed | String |
| latencyElapsed | The elapsed time of the transaction in milliseconds | long |
| microSecTimestamp | Timestamp format of the time the transaction started | String |
| microSecTimestampStart | For internal use | String |
| microSecTimestampFinish | For internal use | String |
| serviceType | Service type as defined in DataPower | String - mpgw,wsp,xml-firewall,b2bgw |
| serviceUri | Request URI | String |
| serviceUrl | Request URL | String |
| srcNodeName | The name of the DPOD node that captured the transaction | String |
| isError | Indication whether the transaction completed with errors | boolean true/false |
| isTechnicalError | Indication whether the transaction completed with errors | boolean true/false |
| clientIp | The client IP of the machine (or load balancer) where the transaction started. | String |
| serviceName | The service the transaction ran on. | String |
| transactionId | DataPower transaction ID (TID) | String |
| transactionGlobalId | DataPower global transaction ID (GTID) | 26 chars long |
| timeZone | The time zone used to log transaction start | String format +ZZZZ |
| docAddedTimeInMil | For internal use | long |
| timeInMil | Transaction start time since Epoch in milliseconds | long number |
| timeHHMMSS | Full time of transaction start | String format HHMMSS where: HH: 00-23 |
| aggRecordVersion | Estimated FW version of the DataPower that executed the transaction. (For internal use) | String |
JSON Example
{
"dpod_index": "[logical-tran-compact_i3][0]",
"dpod_type": "wdpLogicalTransChild",
"dpod_id": "ea5ae3c55b45be5500056a13_348659",
"dpod_timestamp": "2018-07-11T08:22:45.457Z",
"dpod_version": 5,
"dpod_operation": "INDEX",
"dpod_source": {
"deviceName": "1cb3a54303a9",
"domainName": "Infra_Domain",
"latencyElapsed": 2,
"microSecTimestamp": "2018-07-11T11:22:45.313729+03:00",
"microSecTimestampStart": "2018-07-11T11:22:45.313729+03:00",
"microSecTimestampFinish": "2018-07-11T11:22:45.315558+03:00",
"serviceType": "xmlfirewall",
"serviceUri": "/UpdateWantedMenProfiles_WHSW/Service.asmx",
"serviceUrl": "http://Infra.HA:2555/UpdateWantedMenProfiles_WHSW/Service.asmx",
"srcNodeName": "NODE0",
"isError": false,
"isTechnicalError": false,
"clientIp": "172.77.77.5",
"serviceName": "WSS_Loopback.XMLFW",
"transactionId": "348659",
"transactionGlobalId": "ea5ae3c55b45be5500056a13",
"timeZone": "+03:00",
"docAddedTimeInMil": 1531297365329,
"timeHHMMSS": "11:22:45",
"timeInMil": 1531297365313,
"aggRecordVersion": "7.6.0.0+"
}
}
Feature enablement
Perform the following steps to enable this feature
- Install and configure Store plugin.
- Configure each syslog agent.
- Deploy Event Publisher
- Stop and start all system services.
Plugin Configuration
Configure each Store data node (for example: number 2 and 4) as follow:
- cd /app/elasticsearch_nodes/config/MonTier-es-raw-trans-Node-2
- Edit the elasticsearch.yml file
Uncomment the following parameter:
Parameter Values Description events.publisher.plugin.disable false or true enable or disable the plugin
Configure Syslog agent
For each syslog agent in the system perform the following:
- cd /app/flume/syslog_agents/conf/MonTier-SyslogAgent-nn/ (replace nn with the agent number)
- edit the flume_syslog.conf file
- Locate in each agent rows with pattern: MonTier-SyslogAgent-nn.sinks.syslogElasticSinknnn.batchSize = (replace nnn with sink name 1 to 10. Also - replace nn with the agent number)
- Add below each of these rows the line below (substituting nn and nnn as described in step 3 above)
MonTier-SyslogAgent-nn.sinks.syslogElasticSinknnn.serializer.enableLogicalTx = false