net.sf.logdistiller.plugins

Class SamplingPlugin

java.lang.Object

net.sf.logdistiller.LogDistillation.Plugin

net.sf.logdistiller.plugins.FreqPlugin

net.sf.logdistiller.plugins.SamplingPlugin

All Implemented Interfaces:

Serializable

public class SamplingPlugin
extends FreqPlugin

Log sampling plugin: works like FreqPlugin, but saves some log events to a log file.

Parameters (added to FreqPlugin's parameters):

• sampling.filename (default: [id]-sampling.log): name of the file to save the sample of log events for each attribute's value.
• sampling.maxCount (default: 10, -1 = no limit): number of log events to save for each attribute's value.
• sampling.maxSize (default: -1 = no limit): maximum size (in kb) of the sample file

Since:

0.7

See Also:

FreqPlugin, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.logdistiller.plugins.FreqPlugin

FreqPlugin.Freq

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID
static Plugin	TYPE

Fields inherited from class net.sf.logdistiller.plugins.FreqPlugin

attributes, attributesInfo, sorted

Fields inherited from class net.sf.logdistiller.LogDistillation.Plugin

definition, group

Constructor Summary

Constructors

Constructor and Description
SamplingPlugin(LogDistiller.Plugin definition)

Method Summary

Methods

Modifier and Type	Method and Description
void	addLogEventToFreq(LogEvent logEvent, FreqPlugin.Freq freq)
protected void	appendLinkToFreqReport(ReportFormat.PluginReport report) Append links to freq reports, for freq extensions.
void	begin(File destinationDirectory) Begin the log distillation for this plugin instance.
void	end() End the log distillation for this plugin instance.
protected PrintStream	getSamplingLogStream()

Methods inherited from class net.sf.logdistiller.plugins.FreqPlugin

addLogEvent, appendGlobalReport, appendGroupReport

Methods inherited from class net.sf.logdistiller.LogDistillation.Plugin

addLogEvent, getDefinition, getGroup, getId

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final String ID

See Also:

Constant Field Values

TYPE

public static final Plugin TYPE

Constructor Detail

SamplingPlugin

public SamplingPlugin(LogDistiller.Plugin definition)

Method Detail

begin

public void begin(File destinationDirectory)
           throws FileNotFoundException

Description copied from class: LogDistillation.Plugin

Begin the log distillation for this plugin instance.

Overrides:

begin in class FreqPlugin

Parameters:

destinationDirectory - the directory where reports will be stored.

Throws:

FileNotFoundException

getSamplingLogStream

protected PrintStream getSamplingLogStream()
                                    throws FileNotFoundException

Throws:

FileNotFoundException

addLogEventToFreq

public void addLogEventToFreq(LogEvent logEvent,
                     FreqPlugin.Freq freq)
                       throws IOException

Overrides:

addLogEventToFreq in class FreqPlugin

Throws:

IOException

end

public void end()
         throws IOException

Description copied from class: LogDistillation.Plugin

End the log distillation for this plugin instance.

Overrides:

end in class FreqPlugin

Throws:

IOException

appendLinkToFreqReport

protected void appendLinkToFreqReport(ReportFormat.PluginReport report)

Description copied from class: FreqPlugin

Append links to freq reports, for freq extensions.

Overrides:

appendLinkToFreqReport in class FreqPlugin

Parameters:

report - the report formatter