support: Customer Portal
Focused on delivering choice, investment protection and flexibility to organizations with valuable COBOL assets

Veryant Knowledge Base
Home > All Categories > isCOBOL General > How do I turn on debug trace to produce a log file?
Question Title How do I turn on debug trace to produce a log file?

Is there a runtime trace log feature? How do I turn it on? What configuration options are available?
If I have multiple processes running, is there any way to distinguish which log file output goes to, or does all output go to the same log file?


To produce a trace log, set iscobol.tracelevel to a non-zero value. With the default value of 0, the system does not create a log since it would be empty. 

The following are some useful settings:

iscobol.tracelevel=3 includes config settings and program starts and ends. 
iscobol.tracelevel=7 includes config, program starts/ends, and paragraph starts/ends
iscobol.tracelevel=11 includes config, program starts/ends and file i/o (i.e. everything except for paragraph starts/ends)
iscobol.tracelevel=15 is the maximum trace setting. This includes config, program and paragraph starts/ends, and file i/o.

Set iscobol.logfile to a file of your choice.

The isCOBOL framework uses the java.util.logger package, and there are many configuration options. 

For example, you can specify "%h" in the iscobol.logfile and it will be replaced by the user's home directory.

You can specify a "%u" in the iscobol.logfile and it will be replaced with a unique number at runtime to resolve conflicts.

The %u is replaced by a unique number, 0, 1, 2, .... The logic to determine the unique number is to use the lowest number that is not in current use by a process. The log files are "locked" by creating a ".lck" file, and are unlocked by deleting that ".lck" file. So if the filename is fred%u.log and fred0.log.lck exists, the process will create fred1.log (and fred1.log.lck). If fred0.log.lck does not exist then the process will overwrite fred0.log. It does not get appended to.

(The javadoc for FileHandler says "If the FileHandler tries to open the filename and finds the file is currently in use by another process it will increment the unique number field and try again. This will be repeated until FileHandler finds a file name that is not currently in use")

See for other pattern components and logging properties. 

On UNIX/Linux to include a process ID in the log filename, create a shell script and use $$ to substitute the process id of the current shell. For example, to create a log file named myapp followed by an underscore and the process id of the shell, specify "-Discobol.logfile=myapp_$$.log" on your java command line.

Note that these log files will accumulate until they are deleted or until the process id wraps around.

If you do not set iscobol.logfile then the trace log will be written to $ISCOBOL/bin/isrun.log where $ISCOBOL is the isCOBOL installation directory.

The iscobol.logfile value should not be enclosed in double-quotes, even if there are embedded spaces in the path. On Windows, you can use forward slashes or double-backslashes. For example, any of the following will work:
iscobol.logfile=C:\\parent dir\\sub dir\\myapp.log
iscobol.logfile=C:/parent dir/sub dir/myapp.log
iscobol.logfile=/parent dir/sub dir/myapp.log
Authored by: Veryant Support This question has been viewed 11711 times so far.
Click Here to View all the questions in isCOBOL General category.
File Attachments File Attachments
There are no attachment file(s) related to this question.
How helpful was this article to you?
User Comments User Comments Add Comment
There are no user comments for this question. Be the first to post a comment. Click Here
Related Questions Related Questions
  1. How do I compile for compatibility with older versions of Java?
  2. When can I get the " Permission denied:connect" message? And how can it be avoided?
  3. How do I resolve "code too large for try statement" errors?
  4. How do I migrate indexed files to a format that is supported by isCOBOL?
  5. How do I prevent hackers from decompiling Java class files to reverse engineer my COBOL application?
  6. How can I read an Excel spreadsheet from COBOL?
  7. Does SET ADDRESS OF X TO Y work?
  8. What Micro Focus library routines are supported?
  9. Do I need to worry about the compile warning "Note: uses unchecked or unsafe operations?"
  10. What tools are available for automated functional (regression) testing of a COBOL application?
  11. Did you know you can create temporary files in memory?
  12. Where can I obtain a copy of the ANSI 2002 COBOL standard?
  13. Is there currently a way to debug COBOL and Java source together?
  14. How can I tell what changes were made in the isCOBOL latest update?
  15. How do I increase the maximum Java heap size when compiling?
  16. How do I determine what properties are set?
  17. Should I use JISAM or Veryant's c-treeRTG?
  18. How would I create my own CBL_ALLOC_MEM and CBL_FREE_MEM routines?
  19. What is the best way to control Microsoft Word?
  20. How can I use the F10 key in my application without it changing the keyboard focus?
  21. How do I use conditional compilation?
  22. How do I specify properties or a properties file on the command line?
  23. Where can I find more information on A$ENCRYPT and A$DECRYPT?
  24. Does isCOBOL work with Flexus COBOL sp2?
  25. How do I change the icon in the upper left corner of the Window?
  26. What is the behavior difference of STOP THREAD?
  27. Sending SMTP mail
  28. What are the defaults for the DATE-ENTRY control DISPLAY-FORMAT property and format styles?
  29. How do I select 11x17 paper size using WIN$PRINTER?
  30. Where can I learn more about Classpath, the Java class loader, JDK tools and utilities?
  31. What are the key technical advantages of isCOBOL?
  32. Why do I get the error message "Native call not found" and how do I fix the problem?
  33. Why do I get the error java.lang.NoClassDefFoundError: com/iscobol/rts_n/StopRunException?
  34. Can Veryant recommend a good Web site to find 3rd party JavaBeans?
  35. I still get the error : "Missing License: The license key is missing, invalid or has expired!" I can't figure out why
  36. What compile option should I use for ICOBOL compatibility?
  37. Can isCOBOL access a DLL or .so that is in a JAR file?
  38. How do I compile fixed (ANSI) format source that COPYs terminal format source or vice versa?
  39. Can I use directory paths in CALL names?
  40. How do I configure file locations with environment variables?
  41. Is your runtime library backward compatible?
  42. What algorithm does isCOBOL use to load framework properties (runtime config variables)?
  43. How do I set iscobol.file.index.FileName with variable file name assignments?
  44. What is the easiest and/or best way to convert a legacy text-based user interface to a web front end?
  45. How can I make my isCOBOL program to be called instead of a C routine when both have the same name?
  46. Is isCOBOL backward compatible?
  47. How do I specify which file status codes I want to use?
  48. Does isCOBOL APS run on z/OS?
  49. Is there any equivalent to COPY RESOURCE?
  50. Does isCOBOL support C$REDIRECT?
  51. Why do I get the error message “java.lang.UnsatisfiedLinkError: no ### in java.library.path?
  52. What is the best way to profile an isCOBOL program?
  53. How do I write my own replacement for a C$ library routine?
  54. What should I use for USAGE HANDLE items instead of NULL?
  55. How can I avoid the "java.lang.OutOfMemoryError: PermGen space" error?
  56. Can you derive isCOBOL object classes from Java and vice versa?
  57. Can the file system (iscobol.file.index) be set programmatically?
  58. I've heard there is a problem passing pointers to C functions. What is it?
  59. How can I monitor a jvm started on a remote computer box?
  60. How do I get more information when I get java.lang.reflect.InvocationTargetException?
  61. Does isCOBOL support Crystal Reports or other Report Writers?
  62. How do I suppress multiple reserved words with the -rw compiler option?
  63. Why do I get the error message "java.lang.NullPointerException" ?
  64. Why do I get the error message "java.lang.ArrayIndexOutOfBoundsException" ?
  65. Can I call an RMCobol program passing parameters to it?
  66. What does mean the error NO X11 DISPLAY?
  67. How can I encode a URL String?
  68. What can I use to perform an email validation during entry-field accept?
  69. Working with sequential files on Pipes
  70. How do I resolve the error "java.lang.NoClassDefFoundError" or "java.lang.ClassNotFoundException"?
  71. Does isCOBOL support C$XML or other XML interfaces?
  72. Is there any way to direct the output from the "Print Screen" keyboard key directly to a printer?
  73. Why do I get the error "Could not load the main class" ?
  74. Did you know isCOBOL IDE allows you to easily understand how to invoke a method in a Java Class?
  75. Did you know you could set a background image from isCOBOL IDE's painter?
  76. How to replace a text within a string with a different length of text.
  77. How to write custom information inside isCOBOL log file
  78. How to programmatically set the attributes for PDFs?
  79. How can I read data correctly from a line-sequential file that has a different encoding from the one used by isCOBOL?
  80. Did you know you can encrypt the communication with the isCOBOL Server?
  81. GIT Server (Linux) - Install and Configuration
  82. Activating and Check the isCOBOL License
  83. Two options to get the working directory
  84. How to search by key with case insensitive on ISAM files
  85. How can I read a data written with a different encoding?
  86. How do I point my installed isCOBOL to a different Java location?
  87. May I create my own type definitions and reuse them?
  88. How can I generate QR codes from COBOL?
  89. How can I use the Call/Cancel custom HOOK program to get the start and end time of every CALLed program?
  90. How can I tell if my application is running in the WebClient environment or another environment?
  91. Can I define one or more data items based on the definition of another one?
  92. How can you wait for several threads to finish?
  93. Guide to Updating the isCOBOL Software Version in a Standalone, Fat Client or Thin Client Production Environment
  94. Get the week number of the year for a date
Article Information Additional Information
Article Number: 58
Created: 2009-08-31 6:01 PM
Rating: 1 Star
Article Options Article Options
Print Question Print this Question
Email Question Email Question to Friend
Export to Adobe PDF Export to PDF File
Export to MS Word Export to MS Word
Bookmark Article
Subscribe to Article Subscribe to Article
Search Knowledge Base Search Knowledge Base


© Veryant - All Rights Reserved
Veryant and isCOBOL are trademarks or registered marks of Veryant in the United States and other countries. All other marks are the property of their respective owners.