org.thales.punch.platform.api

Class LogRecord

java.lang.Object

org.thales.punch.platform.api.LogRecord

public class LogRecord
extends Object

A LogRecord simply represents a log4j, stdout or stderr trace catched from shiva itself or one of its launched application. These go straight to elasticsearch for monitoring and audit purpose.

This class lets you easily generated normalised xdas format.

Author:

dimi

Constructor Summary

Constructors

Constructor and Description
LogRecord(String platformId, String tenantName, String channelName, String appName, String runnerId, String clusterName, String clusterType)

Method Summary

Modifier and Type	Method and Description
LogRecord	addField(String field, Object value) Add a field to your log
LogRecord	addFields(Map<String,Object> map) Add all fields from an existing maps.
LogRecord	forError() Adds an inner field level to ERROR
LogRecord	forError(org.apache.logging.log4j.Logger logger) Adds an inner field level to ERROR and log the log using the provided local logger.
LogRecord	forInfo() Adds an inner field level to INFO
LogRecord	forInfo(org.apache.logging.log4j.Logger logger) Adds an inner field level to INFO and log the log using the provided local logger.
LogRecord	forWarning() Adds an inner field level to WARN
LogRecord	forWarning(org.apache.logging.log4j.Logger logger) Adds an inner field level to WARN and log the log using the provided local logger.
String	toString() Why a toString method ? because some apps will likely also log the same content using a local log4j logger.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogRecord

public LogRecord(String platformId,
                 String tenantName,
                 String channelName,
                 String appName,
                 String runnerId,
                 String clusterName,
                 String clusterType)

Parameters:

platformId - the unique platform identifier

tenantName - the tenant name, possibly null

channelName - the channel name, possibly null

appName - the application name, possibly null

runnerId - the identifier of the runner storm shiva-leader spark-worker for instance.

clusterName - the name of the runner cluster

clusterType - the type of the cluster shiva spark storm

Method Detail

toString

public String toString()

Why a toString method ? because some apps will likely also log the same content using a local log4j logger.

Overrides:

toString in class Object

addField

public LogRecord addField(String field,
                          Object value)

Add a field to your log

Parameters:

field - the field name

value - the content, must be Json compatible and not null

Returns:

this record

forInfo

public LogRecord forInfo(org.apache.logging.log4j.Logger logger)

Adds an inner field level to INFO and log the log using the provided local logger.

Parameters:

logger - the caller logger

Returns:

this record

forInfo

public LogRecord forInfo()

Adds an inner field level to INFO

Returns:

this record

forError

public LogRecord forError()

Adds an inner field level to ERROR

Returns:

this record

forWarning

public LogRecord forWarning(org.apache.logging.log4j.Logger logger)

Adds an inner field level to WARN and log the log using the provided local logger.

Parameters:

logger - the caller logger

Returns:

this record

forWarning

public LogRecord forWarning()

Adds an inner field level to WARN

Returns:

this record

forError

public LogRecord forError(org.apache.logging.log4j.Logger logger)

Adds an inner field level to ERROR and log the log using the provided local logger.

Parameters:

logger - the caller logger

Returns:

this record

addFields

public LogRecord addFields(Map<String,Object> map)

Add all fields from an existing maps. Use this when you receive an already Json log.

Parameters:

map - the input map (json compatible)

Returns:

this log