Receiving and storing debug information

Use the TestDriver API to set up a test driver instance that receives debug information from specified solution agents and caches the information. You can load test entities into the grid and submit test events for processing. From a test driver instance, use the DebugReceiver interface to capture outbound information from the events for debugging and problem determination.

1. Create a Java™ project by using the TestDriver API methods as described in Creating a test client project.
2. Run the propertyManager set command to configure the server debug port property, or range of ports. For example:

   propertyManager set --username=tester --password=tester debugPort=6543

   The following example sets a range of possible debug ports:

   propertyManager set --username=tester --password=tester debugPort=6543-6600 

3. Configure a test driver instance to receive debug information. Using a text editor, add property names and values to the testdriver.properties file. The host and port that is specified in the debugServers property must match the debugPort property that you set in the previous step. The following example shows a testdriver.properties file that modifies the default host name and port, and provides the solution name and authentication credentials for the tester account.

   solutionName=OilServiceSolution
   host=server1
   port=9443
   debugServers=localhost:6543
   debugAgentList=agent1,agent2
   username=tester
   password=tester

   See Test driver properties for property descriptions and examples. You can also set the test driver properties programmatically by calling the DriverProperties class from a Java project.
   Tip: Create the properties file in the current directory where the Java application is started, or in a location that is defined by the TESTDRIVER_HOME environment variable.
4. Use the DebugReceiver interface to create a debug receiver instance. The interface defines an entry point for DebugInfo by using the addDebugInfo method. The addDebugInfo method is called when the server sends debug information to the test driver client. For example, the following method captures global aggregate values at the time of the test and emits an event with this data:

   public void addDebugInfo(DebugInfo debugInfo, String sourceAgent) {
      Event event = driver.getAgentEvent(debugInfo);
      if (event instanceof TransactionReceipt) {
         TransactionReceipt txReceipt = (TransactionReceipt) event;
         String customerId = txReceipt.getCustomer().getKey();
         double avgTxAmtLast24hrs = txReceipt.getAvgTxAmtLast24hrs();
         double maxTxAmtLast24hrs = txReceipt.getMaxTransactionAmountLast24hrs();
         double numBronze = txReceipt.getNumberOfBronzeCustomers();
         double numGold = txReceipt.getNumberOfGoldCustomers();
         double numPlat = txReceipt.getNumberOfPlatinumCustomers();
         Duration d = Duration.between(firstEventTime, event.get$Timestamp());
         System.out.println(String.format("TXRecepit [%s] hoursSinceFirstEvent=%s, avgTxAmtLast24hrs=%s, maxTxAmtLast24hrs=%s, numPlat=%s, numGold=%s, numBronze=%s, customer=%s, amount=%s",
         event.get$Timestamp(), d.toHours(), avgTxAmtLast24hrs, maxTxAmtLast24hrs, numPlat, numGold, numBronze, customerId, txReceipt.getAmount()));
      }
   }

   where the debugInfo parameter represents the debug information and sourceAgent is the name of the agent that generated the information.

   Start with the sample implementation IADebugReceiver and then customize the debug receiver to work in your environment.

5. Add the debug receiver instance to the test driver client by calling the addDebugReceiver method in the client. For example:

   TestDriver testDriver = null;
   testDriver = new TestDriver();
   DebugReceiver r = new IADebugReceiver();
   testDriver.addDebugReceiver( r );
   testDriver.connect();