com.endeca.infront.assembler.perf.serializers

Class PerfLogTimeEventSerializer

java.lang.Object

com.endeca.infront.assembler.perf.serializers.PerfLogTimeEventSerializer

All Implemented Interfaces:

EventSerializer

Deprecated.

As of release 11.0.
An implementation of EventSerializer that logs time taken, per request, into the assembler performance log.

@Deprecated
public class PerfLogTimeEventSerializer
extends Object

Constructor Summary

Constructors

Constructor and Description
PerfLogTimeEventSerializer(String outputPath, RecordedEventsConfiguration loggableEvents) Deprecated. As of release 11.0. Constructs a PerfLogTimeEventSerializer with a log file count of 5 and a log file limit of 1000 (that is, 1000 megabytes).
PerfLogTimeEventSerializer(String outputPath, RecordedEventsConfiguration loggableEvents, int logFileCount, int logFileLimit) Deprecated. As of release 11.0. Constructs a PerfLogTimeEventSerializer.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	createHeaderForEventSummary(StringBuilder builder, String eventID) Deprecated. As of release 11.0. Appends header text describing the event formatting and time units.
protected List<String>	createLoggables(RecordedEventsConfiguration loggableEvents) Deprecated. As of release 11.0. Iterates through the recorded events in the input RecordedEventsConfiguration to create a list of Strings describing the events.
protected Logger	createLogger(String outputPath, int logFileCount, int logFileLimit) Deprecated. As of release 11.0. Creates a Logger and sets up appropriate formatting.
protected void	emptySummary(StringBuilder builder) Deprecated.
EventFactory	getEventFactory() Deprecated.
protected void	outputHeaderLine() Deprecated. As of release 11.0. Creates the header line, which involves calling createHeaderForEventSummary(StringBuilder, String) for each loggable entry.
void	serialize(Map<String,EventSummary> events, javax.servlet.http.HttpServletRequest request) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

PerfLogTimeEventSerializer

@Deprecated
public PerfLogTimeEventSerializer(String outputPath,
                                     RecordedEventsConfiguration loggableEvents)
                           throws IOException

Deprecated. As of release 11.0.
Constructs a PerfLogTimeEventSerializer with a log file count of 5 and a log file limit of 1000 (that is, 1000 megabytes).

Parameters:

outputPath - The path to the log file to output. The log file name can contain all the wildcards supported by FileHandler. The parameter "%g" must be included in the file name to reflect the number of the log file, or this value will be appended to the name.

loggableEvents - The performance events for CartridgeHandler that this listener should output

Throws:

IOException

PerfLogTimeEventSerializer

@Deprecated
public PerfLogTimeEventSerializer(String outputPath,
                                     RecordedEventsConfiguration loggableEvents,
                                     int logFileCount,
                                     int logFileLimit)
                           throws IOException

Deprecated. As of release 11.0.
Constructs a PerfLogTimeEventSerializer.

Parameters:

outputPath - The path to the log file to output. The log file name can contain all the wildcards supported by FileHandler. The parameter "%g" must be included in the file name to reflect the number of the log file, or this value will be appended to the name.

loggableEvents - The performance events for CartridgeHandler that this listener should output

logFileCount - The number of log files to cycle through.

logFileLimit - The maximum size of a log file, in Megabytes. Once this limit is reached, the log file will rotate.

Throws:

IOException

Method Detail

createHeaderForEventSummary

@Deprecated
protected void createHeaderForEventSummary(StringBuilder builder,
                                          String eventID)

Deprecated. As of release 11.0.
Appends header text describing the event formatting and time units.

Parameters:

builder - the StringBuilder to append to

eventID - the event ID

emptySummary

@Deprecated
protected void emptySummary(StringBuilder builder)

Deprecated.

Parameters:

builder - the StringBuilder to append to

getEventFactory

@Deprecated
public EventFactory getEventFactory()

Deprecated.

Specified by:

getEventFactory in interface EventSerializer

Returns:

EventFactory

outputHeaderLine

@Deprecated
protected void outputHeaderLine()

Deprecated. As of release 11.0.
Creates the header line, which involves calling createHeaderForEventSummary(StringBuilder, String) for each loggable entry.

See Also:

createLoggables(RecordedEventsConfiguration)

createLogger

@Deprecated
protected Logger createLogger(String outputPath,
                             int logFileCount,
                             int logFileLimit)
                       throws IOException

Deprecated. As of release 11.0.
Creates a Logger and sets up appropriate formatting.

Parameters:

outputPath - The path to the log file to output. The log file name can contain all the wildcards supported by FileHandler. The parameter "%g" must be included in the file name to reflect the number of the log file, or this value will be appended to the name.

logFileCount - The number of log files to cycle through.

logFileLimit - The maximum size of a log file, in Megabytes. Once this limit is reached, the log file will rotate.

Throws:

IOException - if a File cannot be created corresponding to the outputPath.

createLoggables

@Deprecated
protected List<String> createLoggables(RecordedEventsConfiguration loggableEvents)

Deprecated. As of release 11.0.
Iterates through the recorded events in the input RecordedEventsConfiguration to create a list of Strings describing the events.

Returns:

list of event descriptions to be logged

serialize

@Deprecated
public void serialize(Map<String,EventSummary> events,
                        javax.servlet.http.HttpServletRequest request)

Deprecated.

Specified by:

serialize in interface EventSerializer

Parameters:

events - the events to serialize

request - the request that generated the given events.