sirius.web.crunchlog

Class CrunchlogKernel

java.lang.Object

sirius.kernel.async.BackgroundLoop

sirius.web.crunchlog.CrunchlogKernel

All Implemented Interfaces:

sirius.kernel.di.std.Named, sirius.kernel.di.std.Priorized, sirius.kernel.health.console.Command, sirius.kernel.health.metrics.MetricProvider, sirius.kernel.Stoppable

public class CrunchlogKernel
extends sirius.kernel.async.BackgroundLoop
implements sirius.kernel.health.console.Command, sirius.kernel.Stoppable, sirius.kernel.health.metrics.MetricProvider

Contains the implementation of the CrunchLog.

This class should not be directly used outside the frameworks it integrates with. The public API resides in Crunchlog.

The implementation stores all incoming records in an internal buffer which is written to disk in one background thread.

The background thread ensures, that one file never spans more than one day and is also limited to be at most MAX_FILE_SIZE bytes large.

If a new file is started, it is ensured that the base directory exists and also that enough free space is avilable on the underlying disk.

If no new file can be created (due to the constraints named above), a warning is output once and all records are ignored until the outside circumstances have changed. The log will then automatically recover and start logging records. This behaviour is probably the best in many circumstances as neighter having the heap buffer grow indefinitely large nor having the filesystem run out of free space is feasible for a server system.

Nested Class Summary

Nested classes/interfaces inherited from interface sirius.kernel.health.console.Command

sirius.kernel.health.console.Command.Output

Field Summary

Fields

Modifier and Type	Field and Description
protected Queue<sirius.kernel.commons.Context>	buffer

Fields inherited from interface sirius.kernel.di.std.Priorized

DEFAULT_PRIORITY

Constructor Summary

Constructors

Constructor and Description
CrunchlogKernel()

Method Summary

Modifier and Type	Method and Description
protected void	addToBuffer(sirius.kernel.commons.Context data)
protected void	collectAllCompletedFiles(Consumer<File> fileProcessor) Implementation of Crunchlog.collectAllCompletedFiles(Consumer)
protected void	doWork()
void	execute(sirius.kernel.health.console.Command.Output output, String... strings)
void	gather(sirius.kernel.health.metrics.MetricsCollector collector)
String	getDescription()
String	getName()
protected double	maxCallFrequency()
void	stopped()

Methods inherited from class sirius.kernel.async.BackgroundLoop

determineExecutor, getExecutionInfo, loop, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface sirius.kernel.Stoppable

getPriority

Field Detail

buffer

protected Queue<sirius.kernel.commons.Context> buffer

Constructor Detail

CrunchlogKernel

public CrunchlogKernel()

Method Detail

addToBuffer

protected void addToBuffer(sirius.kernel.commons.Context data)

getName

@Nonnull
public String getName()

Specified by:

getName in interface sirius.kernel.di.std.Named

Specified by:

getName in class sirius.kernel.async.BackgroundLoop

maxCallFrequency

protected double maxCallFrequency()

Overrides:

maxCallFrequency in class sirius.kernel.async.BackgroundLoop

doWork

protected void doWork()
               throws Exception

Specified by:

doWork in class sirius.kernel.async.BackgroundLoop

Throws:

Exception

stopped

public void stopped()

Specified by:

stopped in interface sirius.kernel.Stoppable

collectAllCompletedFiles

protected void collectAllCompletedFiles(Consumer<File> fileProcessor)

Implementation of Crunchlog.collectAllCompletedFiles(Consumer)

Parameters:

fileProcessor - the processor being supplied with all completed files

gather

public void gather(sirius.kernel.health.metrics.MetricsCollector collector)

Specified by:

gather in interface sirius.kernel.health.metrics.MetricProvider

execute

public void execute(sirius.kernel.health.console.Command.Output output,
                    String... strings)
             throws Exception

Specified by:

execute in interface sirius.kernel.health.console.Command

Throws:

Exception

getDescription

public String getDescription()

Specified by:

getDescription in interface sirius.kernel.health.console.Command