Logging Options

The following log files are provided for DataFlux Data Management Studio:

If enabled, the TKTS log captures TKTS events such as BASE data sets and data sent across the wire to SAS Federation Server. The TKTS log provides a default set of information that cannot be customized.

The Studio log, the Platform log, and the DAC log are enabled by default. These logs use the SAS Logging Facility, a flexible and configurable framework that you can use to collect, categorize, and filter events. Then you can write them to a variety of output devices. The logging facility supports problem diagnosis and resolution, performance and capacity management, and auditing and regulatory compliance.

The logging facility framework categorizes and filters log messages in SAS server and SAS programming environments. It also writes log messages to various output devices. In the server environment, the logging facility logs messages based on predefined message categories such as the following:

Messages for a category can be written to files, consoles, and other system destinations simultaneously. The logging facility also enables messages to be filtered based on the following thresholds, in order from most inclusive to least inclusive: TRACE, DEBUG, INFO, WARN, ERROR, and FATAL. The configuration files for the Studio log, the Platform log, and the DAC log contain a template for logging options. You need only to uncomment certain lines to turn on the corresponding options. For a full description of these options, see the SAS Logging: Configuration and Programming Reference. There are also some DataFlux options for logs. See Data Access Component Logging Options.

The following table specifies the scope, level thresholds, and configuration location for each of these logs:

By default, all Windows XP log files are written to drive:\Documents and Settings\USERNAME\Application Data\DataFlux\DMStudio\[version]\Logs. The default location in Windows 7 is drive:\Users\[username]\AppData\Roaming\DataFlux\DMStudio\[version]\Logs.

All Studio, Platform, and DAC logs by default are all logged to the platform log file. This log file is prefixed with platform_. The DAC logging can be redirected to its own log file by uncommenting the appender-ref setting in the logger section for DF.DAC and by uncommenting the RollingFileAppender section for DacFile. The latter contains the filename pattern that controls where and what name the DAC log file takes. The Studio logging can be redirected to its own log file by uncommenting the appender-ref setting in the logger section for DF.DMStudio and by uncommenting the RollingFileAppender section for DMStudioFile. The latter contains the filename pattern that controls where and what name the Studio log file takes.

The Studio, Platform, and DAC logging all use a logging level of INFO by default. This level is set in the root logger section of the platform.log.xml configuration file. The level value can be changed here to change the default for all three logs. In addition, the logging level for the DAC and Studio logs can be set separately in the DF.DAC and DF.DMStudio logger sections respectively by uncommenting (and possibly updating) the level values in each.

The platform.log.xml file controls all of Studio, Platform, and DAC logging within the DataFlux Data Management Studio application except for job runs. When you run a job, the application creates a separate batch process for that job run. Therefore, you should modify the batch.log.xml to configure logging for jobs.

By default, the Platform log contains run-time statistics for job nodes. See option BASE/MONITOR_FREQUENCY for details about these statistics. To disable all job node statistics from the Platform log, add the following block immediately before the <root> section at the bottom of *.log.xml file:

<logger name="DF.Monitor">

<level value="OFF"/>

</logger>