com.cognifide.gradle.aem.instance.tail

Class InstanceTailer

com.cognifide.gradle.aem.instance.tail.InstanceTailer

public class InstanceTailer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InstanceTailer.Companion

Field Summary

Fields

Modifier and Type	Field and Description
static InstanceTailer.Companion	Companion
static java.lang.String	ENDPOINT_PATH
static java.lang.String	ENDPOINT_PATH_OLD
static long	INCIDENT_OLD_DEFAULT

Constructor Summary

Constructors

Constructor and Description
InstanceTailer(AemExtension aem)

Method Summary

Modifier and Type	Method and Description
java.lang.String	errorLogEndpoint(Instance instance)
AemExtension	getAem()
long	getFetchInterval() Determines how often logs will be polled from AEM instance.
kotlin.jvm.functions.Function2<com.cognifide.gradle.aem.instance.tail.Log,com.cognifide.gradle.aem.common.instance.Instance,java.lang.Boolean>	getIncidentChecker() Determines which log entries are considered as incidents.
long	getIncidentDelay() Time window in which exceptions will be aggregated and reported as single incident.
java.io.File	getIncidentFilter() Path to file holding wildcard rules that will effectively deactivate notifications for desired exception.
java.util.List<com.cognifide.gradle.aem.common.instance.Instance>	getInstances() Instances from which logs will be tailed.
long	getLinesChunkSize()
long	getLockInterval()
java.lang.String	getLogFile()
java.lang.String	getLogFilePath() Determines log file being tracked on AEM instance.
LogFilter	getLogFilter() Log filter responsible for filtering incidents.
kotlin.jvm.functions.Function2<com.cognifide.gradle.aem.instance.tail.Log,com.cognifide.gradle.aem.common.instance.Instance,kotlin.Unit>	getLogListener() Hook for tracking all log entries on each AEM instance.
java.io.File	getRootDir() Directory where log files will be stored.
void	incidentFilter(kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.instance.tail.LogFilter,kotlin.Unit> options)
void	logFilter(kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.instance.tail.LogFilter,kotlin.Unit> options)
void	setFetchInterval(long p) Determines how often logs will be polled from AEM instance.
void	setIncidentChecker(kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.instance.tail.Log,? super com.cognifide.gradle.aem.common.instance.Instance,java.lang.Boolean> p) Determines which log entries are considered as incidents.
void	setIncidentDelay(long p) Time window in which exceptions will be aggregated and reported as single incident.
void	setIncidentFilter(java.io.File p) Path to file holding wildcard rules that will effectively deactivate notifications for desired exception.
void	setInstances(java.util.List<? extends com.cognifide.gradle.aem.common.instance.Instance> p) Instances from which logs will be tailed.
void	setLinesChunkSize(long p)
void	setLockInterval(long p)
void	setLogFilePath(java.lang.String p) Determines log file being tracked on AEM instance.
void	setLogListener(kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.instance.tail.Log,? super com.cognifide.gradle.aem.common.instance.Instance,kotlin.Unit> p) Hook for tracking all log entries on each AEM instance.
void	setRootDir(java.io.File p) Directory where log files will be stored.
void	tail()

Field Detail

ENDPOINT_PATH

@NotNull
public static java.lang.String ENDPOINT_PATH

See Also:

Constant Field Values

ENDPOINT_PATH_OLD

@NotNull
public static java.lang.String ENDPOINT_PATH_OLD

See Also:

Constant Field Values

INCIDENT_OLD_DEFAULT

public static long INCIDENT_OLD_DEFAULT

See Also:

Constant Field Values

Companion

public static InstanceTailer.Companion Companion

Constructor Detail

InstanceTailer

public InstanceTailer(@NotNull
                      AemExtension aem)

Method Detail

getRootDir

@NotNull
public java.io.File getRootDir()

Directory where log files will be stored.

setRootDir

public void setRootDir(@NotNull
                       java.io.File p)

Directory where log files will be stored.

getInstances

@NotNull
public java.util.List<com.cognifide.gradle.aem.common.instance.Instance> getInstances()

Instances from which logs will be tailed.

setInstances

public void setInstances(@NotNull
                         java.util.List<? extends com.cognifide.gradle.aem.common.instance.Instance> p)

Instances from which logs will be tailed.

getLogFilePath

@NotNull
public java.lang.String getLogFilePath()

Determines log file being tracked on AEM instance.

setLogFilePath

public void setLogFilePath(@NotNull
                           java.lang.String p)

Determines log file being tracked on AEM instance.

getLogListener

@NotNull
public kotlin.jvm.functions.Function2<com.cognifide.gradle.aem.instance.tail.Log,com.cognifide.gradle.aem.common.instance.Instance,kotlin.Unit> getLogListener()

Hook for tracking all log entries on each AEM instance.

Useful for integrating external services like chats etc.

setLogListener

public void setLogListener(@NotNull
                           kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.instance.tail.Log,? super com.cognifide.gradle.aem.common.instance.Instance,kotlin.Unit> p)

Hook for tracking all log entries on each AEM instance.

Useful for integrating external services like chats etc.

getLogFilter

@NotNull
public LogFilter getLogFilter()

Log filter responsible for filtering incidents.

logFilter

public void logFilter(@NotNull
                      kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.instance.tail.LogFilter,kotlin.Unit> options)

getIncidentChecker

@NotNull
public kotlin.jvm.functions.Function2<com.cognifide.gradle.aem.instance.tail.Log,com.cognifide.gradle.aem.common.instance.Instance,java.lang.Boolean> getIncidentChecker()

Determines which log entries are considered as incidents.

setIncidentChecker

public void setIncidentChecker(@NotNull
                               kotlin.jvm.functions.Function2<? super com.cognifide.gradle.aem.instance.tail.Log,? super com.cognifide.gradle.aem.common.instance.Instance,java.lang.Boolean> p)

Determines which log entries are considered as incidents.

getIncidentFilter

@NotNull
public java.io.File getIncidentFilter()

Path to file holding wildcard rules that will effectively deactivate notifications for desired exception.

Changes in that file are automatically considered (tailer restart is not required).

setIncidentFilter

public void setIncidentFilter(@NotNull
                              java.io.File p)

Path to file holding wildcard rules that will effectively deactivate notifications for desired exception.

Changes in that file are automatically considered (tailer restart is not required).

getIncidentDelay

public long getIncidentDelay()

Time window in which exceptions will be aggregated and reported as single incident.

setIncidentDelay

public void setIncidentDelay(long p)

Time window in which exceptions will be aggregated and reported as single incident.

getFetchInterval

public long getFetchInterval()

Determines how often logs will be polled from AEM instance.

setFetchInterval

public void setFetchInterval(long p)

Determines how often logs will be polled from AEM instance.

getLockInterval

public long getLockInterval()

setLockInterval

public void setLockInterval(long p)

getLinesChunkSize

public long getLinesChunkSize()

setLinesChunkSize

public void setLinesChunkSize(long p)

errorLogEndpoint

@NotNull
public java.lang.String errorLogEndpoint(@NotNull
                                                   Instance instance)

getLogFile

@NotNull
public java.lang.String getLogFile()

incidentFilter

public void incidentFilter(@NotNull
                           kotlin.jvm.functions.Function1<? super com.cognifide.gradle.aem.instance.tail.LogFilter,kotlin.Unit> options)

tail

public void tail()

getAem

@NotNull
public AemExtension getAem()