Prophecy 9.0 Development Guide Home  |  Frameset Home

  Logging  |  TOC  |  Prophecy Log Search  

The Log Viewer


The Prophecy Log Viewer is a tool that enables users to conveniently monitor the internal operations of Prophecy.  It can be an invaluable tool for obtaining detailed information to aid in the process of developing and debugging IVR applications running on the Prophecy platform. Just like all logging can be written to the Prophecy log files, it can also be sent to the Prophecy Log Viewer. This allows for the Log Viewer to be used for real time monitoring.

Using the Viewer

When the Log Viewer is started it will show a grid with the following columns:

Column Description
Date The date the message was logged
Time The time the message was logged
Message The actual log message itself
Session ID A unique identifier for the session (call); note that log messages not related to a session will leave this field empty
Service The name of the Prophecy component that logged this message
Sender A category used to group related messages; messages can be enabled and disabled by sender, e.g. for any component using the Log4J framework a sender is a category in the Log4J configuration file
Account Identifies the account under which the session was initiated; field will be 0 (zero) when a log message is not related to a session
Type Indicates the priority of the message, possible values in descending order are:
  • Fatal: These messages indicate the component has failed and needs to be restarted.
  • Error: Something went wrong; usually this means a session failed, but the Prophecy component was able to continue it's normal operation.
  • Warn(ing): Something unexpected happened; the session will continue, but probably not as expected.
  • Info: These messages should help application developers debug and analyze their applications
  • Debug: Messages at this level are for Prophecy system operators and hence show messages about the internal of a component relevant to the day to day operations of a Prophecy system.
  • Trace: This level is reserved for Voxeo's software engineers; you might be asked to enable this level for problem resolution purposes, but are usually too cryptic for an end user to understand. Also, logging at this level usually generates to much logging for any production system to handle.
Note that messages can be enabled and disabled based on the type (or priority) so that the amount of logging can be easily controlled.
Host The machine name of the Prophecy server that initiated the message
Number A unique identifier for the parent session. This is the session that spun off the session for which the message was logged, e.g. the CCXML session (which session id would be in this column) that started a VoiceXML dialog (which session id would be in the session id column)




You can select parts of the grid and copy/paste the data by using the platform specific copy/paste short keys or by using the Log Viewer menu. From this menu you can change your viewing preferences and other options. The Log Viewer also has very powerful search capabilities.

Managing files

The Prophecy Log Viewer is able to open log files, making them very easy to view. Note that this is assuming the default log format is used and the default Log4J configuration files have not been changed. This is useful when not monitoring a system in real time. In a similar way the Prophecy Log Viewer can also save the current content of the log viewer to a file. This is very useful in a development/debugging environment. You might, for example, clean the content of the Log Viewer, call the system and perform one complete session. You can now save the content of the Log Viewer to a file which would contain all logging for just this session. As a matter of fact if you contact Voxeo support there is a very good chance they will ask you to do exactly this to help you with your query.

Filters

What makes the Log Viewer most helpful (as opposed to looking at log files in your favorite editor) is the ability to filter its contents. The most typical use cases for filters are to filter all messages for a single session (call) or to filter all messages for a single sender (Prophecy component), so these filters can be triggered right from the context menu. Just select a log message that belongs to the session or sender that you want to filter, right click, and select either "filter by session" or "filter by sender."

Additionally, you can create your own filters by selecting the Edit Filter option from the Filter menu and create filters based on one or more criteria.


  ANNOTATIONS: EXISTING POSTS
0 posts - click the button below to add a note to this page

login
  Logging  |  TOC  |  Prophecy Log Search  

© 2011 Voxeo Corporation  |  Voxeo IVR  |  VoiceXML & CCXML IVR Developer Site