Using CA Continuous Application Insight › CA Continuous Application Insight Agent Light › Agent Light for WebSphere MQ

Agent Light for WebSphere MQ

The Agent Light for WebSphere MQ is an agent that communicates with CA Continuous Application Insight using a REST API. The purpose of the light agent is to take the input from an MQ request/response data file and send the data to CAI through the REST API call.

The agent light can receive the MQ transactions from the following sources:

• MQ transaction data file

  The light agent uses the -f parameter to take a data file as an input. The transaction parameters from the data file are:

  -f, -file

  Defines the transaction data file to be imported into CAI.

  -t, -type

  Defines the data protocol type. HTTP, JMS, and MQ are supported.

  Default: HTTP

  Create a path from data file using the following example code:

  Java -jar lisaagentlight.jar -url http://<LisaServer>:1505 -f mqSample.xml -t mq
  

• Third-party log file from a Splunk query

  Third-party log files are supported using a Splunk query. Splunk indexes the log file and produces the MQ transaction data. The agent light queries Splunk to get the MQ transactions and creates a CAI path for them. The third-party log file may not contain all the information required by the MQ transaction. An extended XML data file is defined to allow users to input the missing data. The data in the extended file must be in the XML format defined by DevTest Solutions.

  The transaction parameters from Splunk are:

  -splunk

  Indicates transactions acquired from Splunk.

  -h, -hostname

  Defines the Splunk server hostname or IP address.

  -port

  Defines the Splunk port number.

  -u, -username

  Defines the Splunk server user name.

  -p, -password

  Defines the Splunk server password.

  -s, -search

  (Optional) Defines the Splunk transaction search statement.

  -t, -type

  Defines the data protocol type. HTTP, JMS, and MQ are supported.

  Default: HTTP

  -m, -maxtrans

  Defines the maximum transactions to be imported.

  Default: 500

  -source

  Defines the Splunk data source, either webMethods, swamq or JMS.

  -extf, -extfile

  Defines the extended transaction data file.

  Create a path from Splunk using the following example code:

  Java -jar lisaagentlight.jar -url http://<LisaServer>:1505 -splunk -hostname 10.130.151.105 -port 8089 -username admin -password admin -source swamq -type mq -extfile extendedDataFile.xml
  

When you query Splunk for third-party transactions, a Splunk query statement must be provided to query for the transactions. The agent has a default query statement built-in. If a different query is needed, you can pass a new query statement using the -search parameter.

The following statement is the built-in default query statement:

"search index=main CASE(\"- REQUEST: <?xml\") OR CASE(\"- RESPONSE: <?xml\") | transaction startsWith=CASE(REQUEST:) endsWith=CASE(RESPONSE:)";

If the Agent Light for WebSphere MQ is executed from a remote system, the DevTest Server REST URL must be specified. Otherwise the agent assumes the DevTest Server is local. The URL format is http://<lisa-server>:1505.

The agent light has the following optional parameters:

-url

Defines the CAI REST base URL.

Default: http://localhost:1505

-wsuser

(Optional) Defines the CAI REST username.

-wspassword

(Optional) Defines the CAI REST password.

Note: The data in the transaction data file and in the extended XML data file must be in the XML format that is defined by DevTest Solutions. See the Input Transaction Data Format for MQ topic for more information about the standard data format.