Generate Sequence Diagrams from Log Files
LogSequencer is a tool that reads your log files and generates Sequence Diagrams based on the logged information.
The generated sequence diagrams can be used for
- documentation of your application,
- debugging of your application logic,
- building up knowledge of an existing application.
Generated Sequence Diagram from Log-File
Include the generated Sequence Diagrams in your application documentation or your Use Cases. LogSequencer generated Sequence Diagrams can be saved a JPEG files and therefore easily imported into your documents.
As a developer it is sometimes difficult to trace and understand all the functionality (i.e. business logic) that fires when the user places a new order, changes an address, etc. LogSequencer generates Sequence Diagrams for these scenarios and it is easy for you to see what methods fire, in which order, and even with what data.
Imagine you start your new job and one of your first tasks is to make yourself familiar with an existing application you don't know at all. You ask for documentation but there is none. Sequence diagrams for different Use Cases would help you a lot. LogSequencer generates these diagrams for you and then it will be much easier for you to understand how objects in that application relate to each other, what methods are used to execute a specific Use Case, etc.
How does LogSequencer Generate Sequence Diagrams
In many software projects it is common practice to have a log file that contains debugging information generated at runtime. It is also common practice to log when an important method of an object is called and when it ends.
You can use AOP (Aspect Oriented Programming, more info) and the AspectJ compiler (with java) to automatically have your classes write the basic logging information.
The steps to add logging to your applications using an aspect are very simple:
- create an aspect class that generates logging (see java example )
- compile your source code and the aspect class with the AspectJ compiler
- run your application
You can download the LogSequencer package (RowParser, an aspect for logging, and a LogSequencer property file ) for AspectJ here.
Click here to find out more about AspectJ.
If you don't want to use AspectJ and your source code does not write the minimum information to generate a sequence diagram
- Class name or object name,
- Method name,
- Method action (i.e. Begin or End),
at the beginning and the end of a method then you need to add logging statements to your source code. The following code snipplet illustrates basic logging (java syntax):
| protected boolean addOrderItem(OrderItem oi) { |
| if (m_isLogging) log("Order", "addOrderItem()", "Begin");
|
| |
| // method logic |
| …………..
|
| |
| if (m_isLogging) log("Order", "addOrderItem()", "End"); |
| return true; |
| } |
Download free evaluation copy now!
LogSequencer has been awarded 5 Star rating by GlobalShareware.
AspectJ References
|
