English

How To: Generate Log files for ArcIMS on UNIX

Summary

Enabling ArcIMS verbose logging functionality for Application Server, Monitor, Tasker, and Spatial Servers is helpful for troubleshooting technical problems with ArcIMS applications or for testing purposes. Instructions provided describe how to enable logging and generate clean log files. Clean log files are useful to troubleshoot issues and narrow down the problem.

Procedure

Follow the steps below to generate and collect the logs.
 

  1. Stop the ArcIMS Services.
    • Navigate to <ArcIMS Installation Directory>/Xenv and use the 'aims_shutdown' script to stop the services.
  2. Enable Aplication Server logging.
    1. Navigate to <ArcIMS Installation Directory>/Middleware/Application_Server/ directory and open the Appserver.properties file in a text editor.
    2. Find the 'debug' and 'logToFile' variables. Set them equal to True:
      debug=True
      logToFile=True 
      
    3. Save and close the Appserver.properties file.
    After restart of ArcIMS Services a new folder called 'log' is created in <ArcIMS Installation Directory>/Middleware/Application_Server directory, which contains the Application Server debug log file.
  3. Enable Spatial Server logging.
    1. Navigate to <ArcIMS Installation Directory>/etc directory and open the aimsserver.cfg file in a text editor. The aimsserver.cfg file is used to define the type of messages written to the log files.
    2. In aimsserver.cfg, find the log files attribute and debug attribute. By default it looks similar to:
      <AIMSSERVER  debug="false"
                   logpath=""
                   logmaxsize=""
                   savefiles="true"    
                   logfiles="2" >
      
    3. Set debug equal to "true" and log files equal to "4", which is Full verbose logging. The file now should look like this:
      <AIMSSERVER  debug="true"
                   logpath=""
                   logmaxsize=""
                   savefiles="true"    
                   logfiles="4" >
      
    4. Save and close the aimsserver.cfg file.
    The log files are created in <ArcIMS Installation Directory >/log directory. Move the log files currently found in <ArcIMS Installation Directory >/log to another directory, such as server/log/oldlogs. This test generates a new set of log files.
  4. Enable Monitor logging.
    1. Navigate to <ArcIMS Installation Directory>/Monitor directory and open the Monitor.properties file in a text editor.
    2. Find the 'debug' and 'logToFile' variables and set them equal to True.
      debug=True
      logToFile=True
      
    3. Save and close the Monitor.properties file.

      After restart of ArcIMS Services there is a new folder called 'log' in <ArcIMS Installation Directory >/Monitor directory. This contains the Monitor debug log file.
    In most cases Monitor log files would not be needed. Enable logging only when necessary.
  5. Enable Tasker logging.
    1. Navigate to <ArcIMS Installation Directory>/Middleware/Tasker directory and open the Tasker.properties file in a text editor.
    2. Find the 'debug' and 'logToFile' variables and set them equal to True:
      debug=True
      logToFile=True
      
    3. Save and close the Tasker.properties file.

      After restart of ArcIMS Services a new folder called 'log' is created in <ArcIMS Installation Directory>/Middleware/Tasker directory, which contains the Tasker debug log file.
    In most cases Tasker log files would not be needed. Enable logging only when necessary.
  6. Start the ArcIMS Services.
    1. Navigate to directory <ArcIMS Installation Directory>/Xenv
    2. Use the 'aims_bootup' script to start the services.
  7. Reproduce the problem and generate log files.
    1. Add and run only the required map services for testing or troubleshooting purposes using the ArcIMS Administration Application.

      This step may remove the existing map services. To avoid this, rename or delete the ESRI Configuration (*.sez) directory. Deleting or renaming the "*.sez" files to "*.old" will remove all the currently available map services from the Application Server. Choosing to rename the *.sez files to *.old, allows recovery of all the map services by renaming the files back to *.sez. If deleting the *.sez files, make sure to note each map service's name and *.axl file before doing so. You can then use your notes to add the map services back after completing this procedure. Remember, map service names are CAsE Sensitive.
      1. Navigate to <ArcIMS Installation Directory>/Middleware/Application_Server.
      2. Rename the ArcIMSFolders.sez (if found) and ArcIMSSite.sez files to ArcIMSFolders.old and ArcIMSSite.old.
    2. Reproduce the problem. Now the log files are generated for the test case.
  8. Collecting the log files created. As soon as the problem behavior has been fully reproduced, collect the following files, found under the <ArcIMS Installation Directory> folder.
    1. Most recent Application Server log files found in the <ArcIMS Installation Directory>/Middleware/Application_Server/log directory.
    2. Most recent Spatial Server log files. All the log files are found in the <ArcIMS Installation Directory>/log directory.
    3. If needed--Most recent Monitor log files. The log files are found in the <ArcIMS Installation Directory>/Monitor/log directory.
    4. If needed--Most recent Tasker log files. The log files are found in the <ArcIMS Installation Directory>/Middleware/Tasker/log directory.

      Collect all the files created for the test case. Tar these files together or as seperate files.

Related Information