Logging

HxMap uses Apache Log4cxx a highly configurable logging framework that could be setup to log differently for each HxMap command line and GUI application. The framework is fully configurable at run time using external configuration files. Each of the HxMap applications have a log configuration file (*.cfg") that could be edited to modify the level of logging(DEBUG, INFO, WARN etc), the file location, the log patter etc.

“ingest.cfg” example:

CODE

# Change INFO to DEBUG if you want full logging
log4j.rootLogger=INFO, RFA
log4j.appender.RFA=org.apache.log4j.RollingFileAppender
log4j.appender.RFA.encoding=UTF-8
log4j.appender.RFA.layout=PatternLayout
log4j.appender.RFA.File=${HXMAP_LOG_PATH}/${HXMAP_LOG_PREFIX}ingest${HXMAP_LOG_SUFFIX}.log

#specify the listing format, see http://logging.apache.org/log4cxx/apidocs/classlog4cxx_1_1PatternLayout.html
log4j.appender.RFA.layout.ConversionPattern=%d [%t] %-5p %c - %m%n

# specify how big the log file should become
log4j.appender.RFA.MaxFileSize=10MB

#if the log file rolls over, how many backup copies should be kept
log4j.appender.RFA.MaxBackupIndex=10

#for the next run, should it append or overwrite the old log file
log4j.appender.RFA.Append=true

The configuration parameters for each command line application are defined using environment variables that are configured by the HxMap job management library

HXMAP_LOG_PATH is used to define the directory where the logs are to be written
HXMAP_LOG_PREFIX/HXMAP_LOG_SUFFIX is used to define the prefix/suffix to be used to append a unique suffix to the log name per run parameters (for example, date and time or Condor Job ID)

The jobs for each of the following processes put their log file according to the table below:

Application	Default Log Path
WFM	in the user AppData roaming. (i.e, “C:\Users\<username>\AppData\Roaming\Hexagon\HxMap\logs”).
Ingest	<Processed Session>\logs
APM	<Triangulation Project>\logs
All other tools (Image Generator, SGM, PC Tool, Texture Generator, etc)	<Output Path>\logs

The job submission library handles the HXMAP_LOG_PATH environment variable based on the type of run:

local run
- set the environment variable of the local runner to point to the Full path of "Default Log Path" as given above
- set HXMAP_LOG_PREFIX to date and time of the job run
- set HXMAP_LOG_SUFFIX to empty so that there is no suffix
cluster run
- Add the "Environment" key to the HTCondor submission file with HXMAP_LOG_PATH as one of the parameter list with absolute path
- set HXMAP_LOG_PREFIX to date and time
- set HXMAP_LOG_SUFFIX to HTCondor Job ID (to make sure different nodes write to different files)