How to use

LogWriter

in

org.pentaho.di.core.logging

/**
 * Get a new log instance for the specified file if it is not open yet!
 * @param filename The log file to open
  * @param exact is this an exact filename (false: prefix of name in temp directory)
 * @return the LogWriter object
 */
// synchronizing logWriter singleton instance PDI-6840
public static final synchronized LogWriter getInstance( String filename, boolean exact ) throws KettleException {
 if ( logWriter != null ) {
  // OK, see if we have a file appender already for this
  //
  if ( logWriter.pentahoLogger.getAppender( LogWriter.createFileAppenderName( filename, exact ) ) == null ) {
   logWriter.fileAppender = createFileAppender( filename, exact );
   logWriter.addAppender( logWriter.fileAppender );
  }
  return logWriter;
 }
 logWriter = new LogWriter( filename, exact );
 return logWriter;
}

private static List<LoggingEvent> convertKettleLoggingEventsToLog4jLoggingEvents( List<KettleLoggingEvent> events ) {
 LogWriter logWriter = LogWriter.getInstance();
 // Copy the events over for compatibility
 List<LoggingEvent> list = new ArrayList<LoggingEvent>();
 for ( KettleLoggingEvent event : events ) {
  LoggingEvent loggingEvent = new LoggingEvent(
   logWriter.getPentahoLogger().getClass().getName(),
   logWriter.getPentahoLogger(), // Category is deprecated
   event.getTimeStamp(),
   convertKettleLogLevelToLog4jLevel( event.getLevel() ),
   event.getMessage(), null );
  list.add( loggingEvent );
 }
 return list;
}

private LogWriter( String filename, boolean exact ) {
 this();
 try {
  fileAppender = createFileAppender( filename, exact );
  addAppender( fileAppender );
 } catch ( Exception e ) {
  System.out.println( "ERROR OPENING LOG FILE [" + filename + "] --> " + e.toString() );
 }
}

 appender = LogWriter.createFileAppender( logFileName, true, false );
 LogWriter.getInstance().addAppender( appender );
 log.setLogLevel( parentJob.getLogLevel() );
} catch ( Exception e ) {
 LogWriter.getInstance().removeAppender( appender );
 appender.close();

public void setupLogFile() {
 String logFileName = "pdi-" + this.getName();
 try {
  appender = LogWriter.createFileAppender( logFileName, true, false );
  LogWriter.getInstance().addAppender( appender );
  log.setLogLevel( parentJob.getLogLevel() );
 } catch ( Exception e ) {
  logError( BaseMessages.getString( PKG,
   "AbstractAmazonJobExecutor.FailedToOpenLogFile", logFileName, e.toString() ) );
  logError( Const.getStackTracker( e ) );
 }
}

LogWriter.getInstance().removeAppender( appender );
appender.close();

public WriterAppenderManager( LogChannelInterface logChannelInterface, LogLevel logLevel, String name ) {
 this( logChannelInterface, logLevel, name, LogWriter.getInstance() );
}

@Override public void close() throws IOException {
 // remove the file appender from kettle logging
 if ( appender != null ) {
  logWriter.removeAppender( appender );
  appender.close();
 }
 Logger pigLogger = Logger.getLogger( "org.apache.pig" );
 if ( pigLogger != null && pigToKettleAppender != null ) {
  pigLogger.removeAppender( pigToKettleAppender );
  pigToKettleAppender.close();
 }
}

/**
 * Get the file input stream for a certain appender.
 * The appender is looked up using the filename
 * @param filename The exact filename (with path: c:\temp\logfile.txt) or just a filename (spoon.log)
 * @param exact true if this is the exact filename or just the last part of the complete path.
 * @return The file input stream of the appender
 * @throws IOException in case the appender ocan't be found
 */
public FileInputStream getFileInputStream( String filename, boolean exact ) throws IOException {
 Appender appender = pentahoLogger.getAppender( createFileAppenderName( filename, exact ) );
 if ( appender == null ) {
  throw new IOException( "Unable to find appender for file: " + filename + " (exact=" + exact + ")" );
 }
 return new FileInputStream( ( (Log4jFileAppender) appender ).getFile().getName().getPathDecoded() );
}

public static final synchronized LogWriter getInstance() {
 if ( logWriter != null ) {
  return logWriter;
 }
 logWriter = new LogWriter();
 return logWriter;
}

 appender = LogWriter.createFileAppender( logFileName, false, false );
 LogWriter.getInstance().addAppender( appender );
 log.setLogLevel( parentJob.getLogLevel() );
} catch ( Exception e ) {
 LogWriter.getInstance().removeAppender( appender );
 appender.close();

public WriterAppenderManager( LogChannelInterface logChannelInterface, LogLevel logLevel, String name,
               LogWriter logWriter ) {
 // Set up an appender that will send all pig log messages to Kettle's log
 // via logBasic().
 KettleLoggingPrintWriter klps = new KettleLoggingPrintWriter( logChannelInterface );
 pigToKettleAppender = new WriterAppender( new Log4jKettleLayout( true ), klps );
 Logger pigLogger = Logger.getLogger( "org.apache.pig" );
 Level log4jLevel = getLog4jLevel( logLevel );
 pigLogger.setLevel( log4jLevel );
 String logFileName = "pdi-" + name; //$NON-NLS-1$
 Log4jFileAppender appender = null;
 this.logWriter = logWriter;
 try {
  appender = LogWriter.createFileAppender( logFileName, true, false );
  logWriter.addAppender( appender );
  logChannelInterface.setLogLevel( logLevel );
  if ( pigLogger != null ) {
   pigLogger.addAppender( pigToKettleAppender );
  }
 } catch ( Exception e ) {
  logChannelInterface.logError( BaseMessages
   .getString( PKG, "JobEntryPigScriptExecutor.FailedToOpenLogFile", logFileName, e.toString() ) ); //$NON-NLS-1$
  logChannelInterface.logError( Const.getStackTracker( e ) );
 }
 this.appender = appender;
}

/**
 * Create a file appender
 * @param filename The (VFS) filename (URL) to write to.
 * @param exact is this an exact filename of a filename to be stored in "java.io.tmp"
 * @return A new file appender
 * @throws KettleFileException In case there is a problem opening the file.
 */
public static final Log4jFileAppender createFileAppender( String filename, boolean exact ) throws KettleFileException {
 try {
  FileObject file;
  if ( !exact ) {
   file = KettleVFS.createTempFile( filename, ".log", System.getProperty( "java.io.tmpdir" ) );
  } else {
   file = KettleVFS.getFileObject( filename );
  }
  Log4jFileAppender appender = new Log4jFileAppender( file );
  appender.setLayout( new Log4jKettleLayout( true ) );
  appender.setName( LogWriter.createFileAppenderName( filename, exact ) );
  return appender;
 } catch ( IOException e ) {
  throw new KettleFileException( "Unable to add Kettle file appender to Log4J", e );
 }
}

/**
 * Create a file appender
 * @param filename The (VFS) filename (URL) to write to.
 * @param exact is this an exact filename of a filename to be stored in "java.io.tmp"
 * @param append
 * @return A new file appender
 * @throws KettleFileException In case there is a problem opening the file.
 */
public static final Log4jFileAppender createFileAppender( String filename, boolean exact, boolean append ) throws KettleFileException {
 try {
  FileObject file;
  if ( !exact ) {
   file = KettleVFS.createTempFile( filename, ".log", System.getProperty( "java.io.tmpdir" ) );
  } else {
   file = KettleVFS.getFileObject( filename );
  }
  Log4jFileAppender appender = new Log4jFileAppender( file, append );
  appender.setLayout( new Log4jKettleLayout( true ) );
  appender.setName( LogWriter.createFileAppenderName( filename, exact ) );
  return appender;
 } catch ( IOException e ) {
  throw new KettleFileException( "Unable to add Kettle file appender to Log4J", e );
 }
}