org.adroitlogic.x.management.tbsr.task

Class DetailedLogArchiveTask

java.lang.Object

org.adroitlogic.x.management.tbsr.task.TaskBase

org.adroitlogic.x.management.tbsr.task.ArchiveTask

org.adroitlogic.x.management.tbsr.task.LogDirArchiveTask

org.adroitlogic.x.management.tbsr.task.DetailedLogArchiveTask

@TaskMeta(id="detailed-logs",name="Detailed Log Sampling",description="takes a detailed log sample over a given time by escalating log levels of specified loggers",maskable=true,intensive=true,taskParameters={@TaskParamMeta(name="output",description="output filename of the temporary log files archive",configurable=false,defaultValue="detailed_logs_[timestamp].tar.gz"),@TaskParamMeta(name="period",description="period (in seconds) over which to collect detailed logs",configurable=true,defaultValue="60"),@TaskParamMeta(name="level",description="level to which logging should be escalated for sampling",configurable=true,defaultValue="DEBUG"),@TaskParamMeta(name="logger",description="logger whose level should be escalated for sampling",configurable=true,defaultValue="org.adroitlogic")})
public class DetailedLogArchiveTask
extends LogDirArchiveTask

Task for retrieval of a detailed server log sample, for UltraESB troubleshoot report generation

Since:

17.01

Author:

Janaka

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static String	DEFAULT_DETAILED_LOG_LEVEL
(package private) static int	DEFAULT_LOG_PERIOD default run configurations
(package private) static org.apache.logging.log4j.Level	DEFAULT_STANDARD_LOG_LEVEL
(package private) static String	LOG_LEVEL
(package private) static String	LOG_PERIOD parameter names
(package private) static String	LOGGER_NAME
(package private) static String	ROOT_LOGGER

Fields inherited from class org.adroitlogic.x.management.tbsr.task.TaskBase

serverConfig

Constructor Summary

Constructors

Constructor and Description
DetailedLogArchiveTask()

Method Summary

Modifier and Type	Method and Description
Status	execute(String outputRoot, Map<String,String> parameters) Executes the core logic of the task.

Methods inherited from class org.adroitlogic.x.management.tbsr.task.LogDirArchiveTask

getMaskableFileTypes, loadSourceFiles

Methods inherited from class org.adroitlogic.x.management.tbsr.task.TaskBase

getDescription, getId, getName, getParameterDetails, isIntensive, isMaskable, setDescription, setId, setIntensive, setMaskable, setName, setParameterDetails, setServerConfig, toView

Methods inherited from class java.lang.Object

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

Field Detail

LOG_PERIOD

static final String LOG_PERIOD

parameter names

See Also:

Constant Field Values

LOG_LEVEL

static final String LOG_LEVEL

See Also:

Constant Field Values

LOGGER_NAME

static final String LOGGER_NAME

See Also:

Constant Field Values

DEFAULT_LOG_PERIOD

static final int DEFAULT_LOG_PERIOD

default run configurations

See Also:

Constant Field Values

ROOT_LOGGER

static final String ROOT_LOGGER

See Also:

Constant Field Values

DEFAULT_DETAILED_LOG_LEVEL

static final String DEFAULT_DETAILED_LOG_LEVEL

See Also:

Constant Field Values

DEFAULT_STANDARD_LOG_LEVEL

static final org.apache.logging.log4j.Level DEFAULT_STANDARD_LOG_LEVEL

Constructor Detail

DetailedLogArchiveTask

public DetailedLogArchiveTask()

Method Detail

execute

public Status execute(String outputRoot,
                      Map<String,String> parameters)
               throws Exception

Description copied from class: TaskBase

Executes the core logic of the task. This method should dump the output of the task to a preconfigured file on the instance, located at the location pointed to by the File.separator-terminated path defined by the outputRoot parameter. Any exceptions should be thrown to the base method, for maintaining proper exception notification.

Overrides:

execute in class ArchiveTask

Parameters:

outputRoot - root directory for task output file(s)

parameters - runtime parameters for the task

Returns:

final execution status of task

Throws:

Exception - in case of a failure to execute the task