Overview

The Logger shows all ActiveMQ/VHMSG messages and saves them all to disk. You can find them in \local_tests in your project folder. The Logger also allows you to send ActiveMQ messages. This component starts automatically when the Launcher starts; this behavior can be turned off in the Launcher.

The logger allows you to create custom filters that will search through the messages and only display messages that satisfy the filter, save all of the messages or some filtered ones to a text file, import messages, and search through the messages.

The filters are not case sensitive and search the entire message; you are given the option to create "Positive" (contains) or "Negative" (does not contain) filters. You can also create an advanced filter which lets you enter up to 5 terms, and chose the logical operator used to join the terms.

JLogger automatically timestamps all messages, and adds a header to every file it saves. The current format for the time stamps is as follows: HourMinSecMillisec where Hour, Min, and Sec are 2 digits and Millisec is up to three digits. You can create your own tag per session which will be added to the files and folder; the default tag is 'automated-test'

See the Javadoc for information about the source code.

Users

The JLogger.jar file in the dist folder is the actual program to launch. It requires the lib folder to be in the same folder with it. You can double click on the run-logger.bat file in launch-scripts folder (in \tools\launch-scripts) or double click JLogger.jar (inside \tools\logger or \tools\logger\dist or \bin\logger\dist) to launch the program

Using JLogger

• The "All Messages" tab will display every VHMSG message that is sent by any program.
  
  • You cannot close this tab
• If the "Auto-Scroll" checkbox is checked, the textareas in all of the filters will automatically scroll when they receive a message if necessary
• If the "Word Wrap" feature is set, the text in the textareas will wrap to the next line instead of scrolling off to the right
• You can clear all messages from the logger by going to Edit->Clear Log and then choosing "Yes" in the dialog box that pops up
  
  • Note: this will clear all messages from all filters as well
• The JLogger displays its current status by highlighting the button area green or red depending on whether it is logging or not.

Creating and Removing a Filter

• You can create a filter by going to Filters->Create Simple Filter and typing some text into the text field labeled "Filter" and clicking the "Create Filter" button
  
  • A new tab will be added with the text you entered as its name
  • Every message that satisfies your filter will be displayed here
  • If the "Positive" radio button is selected, you will create a positive filter
    
    • The tab name will also be prepended by "[+]"
  • If the "Negative" radio button is selected, you will create a negative filter
    
    • The tab name will also be prepended by "[-]"
• You can remove a filter by selecting the tab, right clicking on the tab and then selecting the close current filter option.

Creating and Removing an Advanced Filter

• The Advanced Filter is like a regular filter, but you can enter up to 5 terms
  • Go to Filters->Create Advanced Filter and a dialog window will come up
  • Enter your filter terms and if they are positive or negative (this part works the same way as the regular filters)
  • Select whether you want the 'and' or 'or' logical operator: the 'and' logical operator implies that a messages satisfies the advanced filter if it satisfies all of the individual filters, while the 'or' logical operator implies a message satisfies the advanced filter if it satisfies at least one of the individual filters.
    • Note: An individual filter refers to a (term, positive-negative value) pair.
  • Click the "Create" button to create your filter or the "Cancel" button to cancel
• The tab's label is named in the same way that a regular filter except that it uses the logical operator selected to delimit individual terms.
• The advanced filter tabs can be closed in the same way as the regular filters.

Saving a Log

• You can save "All Messages" by going to File->[All Messages] Save As...
• You can save a filter by selecting its tab and going to File->[Current Filter] Save As..
• When you click one of the Save As... menu items you will be presented with a save dialog window where you can choose where to save your log

Importing a Log

• Be sure to choose a file that was created by JLogger or there may be some unexpected behavior or results
• Any messages currently in the log will be cleared

1. 1. Go to File->Import Log...
   2. Click "yes" if you still want to import a log
   3. Select the file you want to import and click "Import"

• A file can also be imported at start up (via the command line arguments)
  • If you start the JLogger using its jar file, the following is an example of the command for importing a log file: java -jar JLogger.jar C:/logFile.txt

Staring/Stopping a Logging Session

• To start the logging session, click on the "Start Logging" button
• To stop the logging session, click on the 'Stop Logging" button

Stopping and starting a logging session automatically increments the loggin session number.

Getting the Path of the Log Files

• JLogger has to be currently logging for this option to be enabled:
  • Go to Options->Get Logging Path and a dialog will appear displaying the current path where the log files are being stored to.

Changing and Resetting the Session Name

• To change the session name:

1. 1. Delete the text in the text field labeled 'Session Name'
   2. Enter the new Session Name into this text field
   3. Press Enter

• To reset the session name go to Edit->Reset Session Name
• If you would like to know the default session name before resetting it, go to Options->Get Default Session Name

• Note: If the logger is currently logging, the session name change will not take effect until a new logging session starts.

Searching

• Go to Search->By Keyword and a dialog will appear.
• Enter the text you wish to search for in the text field provided and press Enter.
• Press F3 to search forward in the text or Shift+F3 to search backwards.
• Select Cancel when you are done searching to close the search dialog.

• Note: If the Autoscroll checkbox is selected when you do a search, JLogger will deselect it, and you must select it again when you are done searching if you wish to enable it again.
• Note: If you press enter when the cursor is in the search text field, the search will restart from the beginning of the document again.

Help

• To display information about the JLogger

1. 1. Go to Help -> About JLogger
   2. A new dialog will appear, giving you more information about JLogger
   3. When you are done reading/viewing the information, click on Ok to exit.

• To display information about How to ...

1. 1. Go to Help->How To ...
   2. A new dialog will appear giving you information about the most common How To's of JLogger.
   3. When you are done reading/viewing this information, click ok to exit.

Developers

Compiling the Logger

You can compile with either NetBeans or with ant

Pre-Compiling:

1. Go to \saso\lib\vhmsg\vhmsg-java\ and check if je4util.jar exists there
   • If it does not exist, then you have to compile it by navigating to that folder in a command prompt window and typing 'ant' (no quotes). If that doesn't work, then you will need to install ant: http://ant.apache.org
2. Go to \saso\lib\java\ and check if it contains nblibraries.properties, and swing-layout\swing-layout-1.0.3.jar
   • If it does not exist, then you cannot compile the project
3. Make sure that the environmental variable JAVA_HOME is set to your JDK folder before continuing
   • You can check the value of JAVA_HOME by running the check-environmental-variables.bat file
   • If it is not defined, see the Pre-Running section for instructions on how to set it

Compiling with NetBeans:

1. The folder that this file is in (\JLogger), is a NetBeans project folder. You can get NetBeans from http://www.netbeans.org if it is not already installed
2. Run NetBeans and go to File->Open Project and select the folder
3. Click the button with the hammer picture on it (or Build->Build Main Project or F11)

Compiling with ant:

1. Open a command prompt window and navigate to the \JLogger Java folder.
2. Type 'ant' (no quotes)

Message API

Receiving:

• vrAllCall
• vrKillComponent
• logging

Sending:

• vrComponent
• vrProcEnd
• logging