org.jahia.services.logging

Interface MetricsLoggingService

All Known Implementing Classes:

MetricsLoggingServiceImpl

public interface MetricsLoggingService

This Service offer you to log information for metrics usages (not for information or debugging purposes).

Or to profile some operations.

Since:

JAHIA 6.5 Created : 24 nov. 2009

Author:

: rincevent

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
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 sessionID, String ipAddress, String nodeIdentifier, String path, String nodeType, String logTemplate, String... args) Log some metric about a node.
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 found 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

Method Detail

isEnabled

boolean isEnabled()

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

Returns:

true if the logging is generally enabled; false otherwise

isProfilingEnabled

boolean isProfilingEnabled()

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

Returns:

true if the profiler logging is generally enabled; false otherwise

logContentEvent

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

Log some metric about a node.

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 output 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

void startProfiler(String profilerName,
                   String action)

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

Parameters:

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

action - the action you want to profile

stopProfiler

void stopProfiler(String profilerName)

Stop all profiling for this profiler name

Parameters:

profilerName - the name of the profiler you want to stop

createNestedProfiler

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

Create a sub profiler of an existing profiler

Parameters:

parentProfilerName - the parent profiler name

nestedProfilerName - the sub profiler name

Returns:

the nested profiler

stopNestedProfiler

void stopNestedProfiler(String parentProfilerName,
                        String nestedProfilerName)

Stop a nested profiler

Parameters:

parentProfilerName - the parent profiler name

nestedProfilerName - the sub profiler name

startProfiler

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

Start a new profiler and return it to the caller.

Parameters:

profilerName - the new profiler you want to start

Returns:

the newly created Profiler