Package com.illumon.iris.db.util.logging

Class ProcessEventLogInterceptorCsv

java.lang.Object

com.illumon.iris.db.util.logging.ProcessEventLogInterceptorCsv

All Implemented Interfaces:

IProcessEventLogInterceptor

public class ProcessEventLogInterceptorCsv
extends Object
implements IProcessEventLogInterceptor

Implementation of IProcessEventLogInterceptor which writes to CSV files. Several properties control the behavior of this interceptor.

• PROCESS_LOG_INTERCEPT_CSV_DIRECTORY_PROP (mandatory) specifies the directory into which files will be written
• PROCESS_LOG_INTERCEPT_CSV_FORMAT_PROP specifies the CSV format, defaults to Excel (see CSVFormat.Predefined
• PROCESS_LOG_INTERCEPT_CSV_DELIMITER_PROP specifies the delimiter, defaults to the default for the CSV format
• PROCESS_LOG_INTERCEPT_CSV_QUEUE_CAPACITY_PROP specifies the queue size for outstanding events to be written to the CSV file; if this is exceeded, events will be ignored
• PROCESS_LOG_INTERCEPT_CSV_ROLLOVER_DAILY_PROP specifies whether the files should rollover each day, defaults to true
• PROCESS_LOG_INTERCEPT_CSV_ROLLOVER_HOURLY_PROP specifies whether the files should rollover each hour, defaults to false and if set to true takes precedence over PROCESS_LOG_INTERCEPT_CSV_ROLLOVER_DAILY_PROP
• PROCESS_LOG_INTERCEPT_CSV_TIMEZONE_PROP defines a timezone for the rollover (defaults to system default)
• PROCESS_LOG_INTERCEPT_CSV_FLUSH_MESSAGES how frequently to flush the queue to disk (it will always flush when emptied)
• PROCESS_LOG_INTERCEPT_CSV_TRIM_FINAL_NEWLINE if true, the last newline at the end of PEL messages will be trimmed before writing the default value is 100
• PROCESS_LOG_INTERCEPT_CSV_INCLUDE_FIELDS a space or comma separated list of case-insensitive field names to include in the cvs file. If blank or not present, all fields will be logged. Field values must be in this set: [timestamp, host, level, process, authorizedUser, effectiveUser, logEntry, processInfoId].

Constructor Summary

Constructors

Constructor	Description
ProcessEventLogInterceptorCsv(com.fishlib.configuration.Configuration configuration, String hostName, String processName)

Method Summary

Modifier and Type	Method	Description
void	close()	Close (and flush) all resources associated with this interceptor.
void	intercept(long timestamp, String host, String level, String process, String processInfoId, io.deephaven.enterprise.auth.UserContext userContext, String logEntry)	An intercept event with the specified PEL data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ProcessEventLogInterceptorCsv

public ProcessEventLogInterceptorCsv(@NotNull
 com.fishlib.configuration.Configuration configuration,
 @NotNull
 String hostName,
 @NotNull
 String processName)

Method Details

intercept

public void intercept(long timestamp,
 String host,
 String level,
 String process,
 String processInfoId,
 io.deephaven.enterprise.auth.UserContext userContext,
 String logEntry)

Description copied from interface: IProcessEventLogInterceptor

An intercept event with the specified PEL data.

Specified by:

intercept in interface IProcessEventLogInterceptor

Parameters:

timestamp - the timestamp

host - the host

level - the log level

process - the process name

userContext - the user context

logEntry - the log entry

close

public void close()

Description copied from interface: IProcessEventLogInterceptor

Close (and flush) all resources associated with this interceptor.

Specified by:

close in interface IProcessEventLogInterceptor