org.jahia.services.logging

Class MetricsLoggingServiceImpl

java.lang.Object

org.jahia.services.logging.MetricsLoggingServiceImpl

All Implemented Interfaces:

MetricsLoggingService

public class MetricsLoggingServiceImpl
extends Object
implements MetricsLoggingService

Default implementation of the metrics logging service, that logs to a specific Log4J appender using template strings to customize output. The template strings are partially hardcoded in this class, and partially configured in the Spring configuration file.

Since:

JAHIA 6.5 Created : 24 nov. 2009

Author:

: rincevent

Constructor Summary

Constructors

Constructor and Description
MetricsLoggingServiceImpl()

Method Summary

Modifier and Type	Method and Description
org.slf4j.profiler.Profiler	createNestedProfiler(String parentProfilerName, String nestedProfilerName) Create a sub profiler of an existing profiler
static MetricsLoggingServiceImpl	getInstance() Returns the singleton instance, and creates it if not existing yet
boolean	isEnabled() Returns true if the logging is generally enabled; false otherwise.
boolean	isProfilingEnabled() Returns true if the profiler logging is generally enabled; false otherwise.
void	logContentEvent(String user, String ipAddress, String sessionID, String nodeIdentifier, String path, String nodeType, String logTemplate, String... args) Log some metric about a node.
void	setIgnoreUsers(Set<String> ignoreUsers)
void	setLogTemplatesMap(Map<String,String> logTemplatesMap)
org.slf4j.profiler.Profiler	startProfiler(String profilerName) Start a new profiler and return it to the caller.
void	startProfiler(String profilerName, String action) Start a profiler and start the associated action (if the profilerName is not foudn it will create it)
void	stopNestedProfiler(String parentProfilerName, String nestedProfilerName) Stop a nested profiler
void	stopProfiler(String profilerName) Stop all profiling for this profiler name

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricsLoggingServiceImpl

public MetricsLoggingServiceImpl()

Method Detail

getInstance

public static MetricsLoggingServiceImpl getInstance()

Returns the singleton instance, and creates it if not existing yet

Returns:

the singleton instance, either existing or newly created.

setLogTemplatesMap

public void setLogTemplatesMap(Map<String,String> logTemplatesMap)

setIgnoreUsers

public void setIgnoreUsers(Set<String> ignoreUsers)

logContentEvent

public void logContentEvent(String user,
                            String ipAddress,
                            String sessionID,
                            String nodeIdentifier,
                            String path,
                            String nodeType,
                            String logTemplate,
                            String... args)

Log some metric about a node.

Specified by:

logContentEvent in interface MetricsLoggingService

Parameters:

user - user achieving the operation

ipAddress - ip address of the user

sessionID - if available, the identifier of the session, otherwise null or an empty string is fine. Note that if you use null it will be outputted verbatim in the log.

nodeIdentifier - if available, the node identifier on which the event took place, otherwise null

path - the node path on which the operation has been achieved

nodeType - the type of the node

logTemplate - the name of the template log you want to use.

args - variable list of arguments depending of the template you choose

startProfiler

public void startProfiler(String profilerName,
                          String action)

Start a profiler and start the associated action (if the profilerName is not foudn it will create it)

Specified by:

startProfiler in interface MetricsLoggingService

Parameters:

profilerName - name of the profiler you want to use or create

action - the action you want to profile

stopProfiler

public void stopProfiler(String profilerName)

Stop all profiling for this profiler name

Specified by:

stopProfiler in interface MetricsLoggingService

Parameters:

profilerName - the name of the profiler you want to stop

createNestedProfiler

public org.slf4j.profiler.Profiler createNestedProfiler(String parentProfilerName,
                                                        String nestedProfilerName)

Create a sub profiler of an existing profiler

Specified by:

createNestedProfiler in interface MetricsLoggingService

Parameters:

parentProfilerName - the parent profiler name

nestedProfilerName - the sub profiler name

Returns:

the nested profiler

stopNestedProfiler

public void stopNestedProfiler(String parentProfilerName,
                               String nestedProfilerName)

Stop a nested profiler

Specified by:

stopNestedProfiler in interface MetricsLoggingService

Parameters:

parentProfilerName - the parent profiler name

nestedProfilerName - the sub profiler name

startProfiler

public org.slf4j.profiler.Profiler startProfiler(String profilerName)

Description copied from interface: MetricsLoggingService

Start a new profiler and return it to the caller.

Specified by:

startProfiler in interface MetricsLoggingService

Parameters:

profilerName - the new profiler you want to start

Returns:

the newly created Profiler

isEnabled

public boolean isEnabled()

Description copied from interface: MetricsLoggingService

Returns true if the logging is generally enabled; false otherwise.

Specified by:

isEnabled in interface MetricsLoggingService

Returns:

true if the logging is generally enabled; false otherwise

isProfilingEnabled

public boolean isProfilingEnabled()

Description copied from interface: MetricsLoggingService

Returns true if the profiler logging is generally enabled; false otherwise.

Specified by:

isProfilingEnabled in interface MetricsLoggingService

Returns:

true if the profiler logging is generally enabled; false otherwise