The debug export utility allows you to gather and analyze data used in the Data Capture and Delivery component of WebSphere® Premises Server.
Data | Description |
---|---|
OSGi short status (ss) | The contents of the OSGi ss command are displayed. |
OSGi status | The contents of the OSGi status command are displayed. |
System properties | A list of system properties is displayed in alphabetical order. This list can help you find specific properties more quickly. |
VM information | Various data can be gathered from the VM such as free memory and maximum memory. |
config.ini | The contents of the config.ini file are displayed from the location given by the osgi.configuration.area system property plus /config.ini. |
EdgeXML | The contents of the Data Capture and Delivery XML file are displayed from the URL given by the com.ibm.rfid.edge.config.url system property. |
OSGi ConfigAdmin | The contents of the OSGi ConfigurationAdmin (ConfigAdmin)
data structure are displayed in the following format for each configuration:PID: Factory PID: Bundle Location: Properties: [property…0] . . . [property…n] |
matrix properties file | The contents of the matrix file are displayed from the location given by the matrix.properties property in the Portal Controller Configuration in ConfigurationAdmin. |
Data Capture and Delivery log entries | The previous n log entries made will display with n being the current value of the LogService log.size property. The most recent entry is at the bottom. |
The utility ships as a set of bundles that allows you to view the data through a servlet (com.ibm.rfid.support.debug.servlet), in a file (com.ibm.rfid.support.debug.file), or through a socket (com.ibm.rfid.support.debug.socket). The bundles are installed with the IBM® Data Capture and Delivery Toolkit for WebSphere Premises Server and are also installed in the Data Capture and Delivery bundles directory on WebSphere Premises Server. In the toolkit, the bundles will be loaded and started as part of the launch configurations. In the bundle lists on WebSphere Premises Server, the file and server socket export bundles will be loaded and started by default. The servlet view bundle is installed and started automatically with Data Capture and Delivery. Regardless of which view is being used, the com.ibm.rfid.support.debug.model bundle must always be installed since the other bundles depend on it.
You can view data through a servlet. The servlet presents the data in an organized way that can be easily viewed in a Web browser. Each export of specific data has its own section in the servlet that can be expanded or collapsed to easily view the data. Exports that encounter an error will identify where the error occurred with an icon next to the title of the section. Each time the Web browser is refreshed the most current debug data will be displayed.
The servlet view bundle is installed and started automatically with Data Capture and Delivery.
To use the servlet export functionality, access the following URL in a Web browser: http://ip_address:8777/datacapture/debug
You can also access the servlet by accessing the following URL and then clicking debug: http://ip_address:8777/device
You can view data in a file. Debug data is gathered and exported to a time-stamped text file in the directory specified by the com.ibm.rfid.support.debug.file.path property, which defaults to the path specified by the osgi.install.area system property. The format of the file name is DataCaptureDebugLogs_yyyy-mm-dd_hh-mm-ss-xxx, where the timestamp consists of year, month, day, hour, minute, second, and milliseconds. The text file is organized with a section at the top that displays the names of the exports that encountered errors. The rest of the text file consists of clearly labeled sections that contain data from the various exports.
The file view bundle is installed with Data Capture and Delivery, but is not started by default. Once you start the bundle, it gathers the data, exports it to the file, and then stops itself. Permissions must be set to allow the bundle to write to the hard drive.
To use the file export functionality, start the bundle. Then view the debug_file_path/DataCaptureDebugLogs_yyyy-mm-dd_hh-mm-ss-xxx file.
If you cannot run a full JRE (allowing use of the servlet) or cannot write to the hard drive, you can export the data through a server socket and then decide what to do with the data.
The socket view bundle is installed with Data Capture and Delivery, and it is started by default. Once you start the bundle, it opens a server socket using the default port number 12345; however, this port number is configurable.
The port number is configurable through the com.ibm.rfid.support.debug.socket.port system property which defaults to 12345 at start. To change this port number, stop the bundle, update the property to the new port number, and restart the bundle. The socket will now use the new port number assigned to the com.ibm.rfid.support.debug.socket.port property.
The bundle waits until a client connects to it through the port and then gathers the debug data and exports it through the client-server connection. The data is transferred in the same format as that sent to the file. You can choose where to have the data sent. After the data is transferred, the client-server connection is closed and the server socket waits until another connection is made. The bundle remains active until you stop it.
To use the socket export functionality, start the bundle if it is not already started. Then connect to it through a client (for example, using Telnet) and export the data to the location of your choice.