Package com.orientechnologies.agent.profiler

Class OEnterpriseProfiler

java.lang.Object

com.orientechnologies.common.concur.resource.OSharedResourceAbstract

com.orientechnologies.common.profiler.OAbstractProfiler

com.orientechnologies.agent.profiler.OEnterpriseProfiler

All Implemented Interfaces:

OProfiler, OProfilerMXBean, OService, OOrientStartupListener, ODistributedLifecycleListener

public class OEnterpriseProfiler
extends OAbstractProfiler
implements ODistributedLifecycleListener

Profiling utility class. Handles chronos (times), statistics and counters. By default it's used as Singleton but you can create any instances you want for separate profiling contexts.

To start the recording use call startRecording(). By default record is turned off to avoid a run-time execution cost.

Author:

Luca Garulli

Nested Class Summary

Nested classes/interfaces inherited from class com.orientechnologies.common.profiler.OAbstractProfiler

OAbstractProfiler.OProfilerHookRuntime, OAbstractProfiler.OProfilerHookStatic, OAbstractProfiler.OProfilerHookValue

Nested classes/interfaces inherited from interface com.orientechnologies.common.profiler.OProfiler

OProfiler.METRIC_TYPE

Field Summary

Fields

Modifier and Type	Field	Description
protected TimerTask	archiverTask
protected TimerTask	autoPause
protected static final int	BUFFER_SIZE
protected int	elapsedToCreateSnapshot
static final int	KEEP_ALIVE
protected Date	lastReset
protected final AtomicReference<OProfilerData>	lastSnapshot
protected final int	metricProcessors
protected AtomicBoolean	paused
protected Set<OEnterpriseProfilerListener>	profilerListeners
protected OProfilerData	realTime
protected OEnterpriseServer	server
protected final Timer	timer
protected AtomicLong	timestamp

Fields inherited from class com.orientechnologies.common.profiler.OAbstractProfiler

autoDumpTask, dictionary, hooks, listeners, recordingFrom, types

Fields inherited from class com.orientechnologies.common.concur.resource.OSharedResourceAbstract

lock

Constructor Summary

Constructors

Constructor	Description
OEnterpriseProfiler()
OEnterpriseProfiler(int iElapsedToCreateSnapshot, OAbstractProfiler iParentProfiler, OEnterpriseServer server)

Method Summary

Modifier and Type	Method	Description
protected Map<String,OAbstractProfiler.OProfilerHookStatic>	archiveHooks()	Must be not called inside a lock.
void	configure(String iConfiguration)
double	cpuUsage()
double	cpuUsageFallback()
String	dump()
void	dump(PrintStream printStream)
String	dumpChronos()
String	dumpCounters()
String	dumpHookValues()
String	dumpStats()
OProfilerEntry	getChrono(String iChronoName)
List<String>	getChronos()
ODocument	getContext()
long	getCounter(String iStatName)
List<String>	getCounters()
String[]	getCountersAsString()
Object	getHookValue(String iName)
Date	getLastReset()
OProfilerEntry	getStat(String iStatName)
String	getStatsAsJson()
String[]	getStatsAsString()
protected AtomicInteger	getTip(String iMessage)
boolean	isEnterpriseEdition()
String	metadataToJSON()
void	onDatabaseChangeStatus(String iNode, String iDatabaseName, ODistributedServerManager.DB_STATUS iNewStatus)	Called upon change of database status on a node.
void	onNodeJoined(String iNode)	Called right after a node joined the cluster.
boolean	onNodeJoining(String iNode)	Called when a node is joining the cluster.
void	onNodeLeft(String iNode)	Called right after a node left the cluster.
void	registerProfilerListener(OEnterpriseProfilerListener listener)
void	resetRealtime(String iText)
void	setAutoDump(int iSeconds)
protected void	setTip(String iMessage, AtomicInteger counter)
void	shutdown()
long	startChrono()
boolean	startRecording()
long	stopChrono(String iName, String iDescription, long iStartTime)
long	stopChrono(String iName, String iDescription, long iStartTime, String iDictionaryName)
long	stopChrono(String iName, String iDescription, long iStartTime, String iDictionaryName, String iPayload)
long	stopChrono(String iName, String iDescription, long iStartTime, String iDictionaryName, String iPayload, String user)
boolean	stopRecording()
String	toJSON(String iQuery, String iPar1)
void	unregisterProfilerListener(OEnterpriseProfilerListener listener)
void	updateCounter(String iName, String iDescription, long iPlus)
void	updateCounter(String iName, String iDescription, long iPlus, String iMetadata)
long	updateStat(String iName, String iDescription, long iValue)
void	updateStats()

Methods inherited from class com.orientechnologies.common.profiler.OAbstractProfiler

dump, dumpEnvironment, getChronosAsString, getDatabaseMetric, getHookAsString, getMetadata, getName, getProcessMetric, getSystemMetric, getType, installMemoryChecker, isRecording, onStartup, registerHookValue, registerHookValue, registerListener, reportTip, startup, threadDump, unregisterHookValue, unregisterListener, updateMetadata

Methods inherited from class com.orientechnologies.common.concur.resource.OSharedResourceAbstract

acquireExclusiveLock, acquireSharedLock, releaseExclusiveLock, releaseSharedLock

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.orientechnologies.orient.server.distributed.ODistributedLifecycleListener

onMessageAfterOp, onMessageBeforeOp, onMessageCurrentPayload, onMessageProcessEnd, onMessageProcessStart, onMessageReceived

Field Details

timer

protected final Timer timer

BUFFER_SIZE

protected static final int BUFFER_SIZE

See Also:

• Constant Field Values

KEEP_ALIVE

public static final int KEEP_ALIVE

See Also:

• Constant Field Values

metricProcessors

protected final int metricProcessors

lastReset

protected Date lastReset

realTime

protected OProfilerData realTime

lastSnapshot

protected final AtomicReference<OProfilerData> lastSnapshot

elapsedToCreateSnapshot

protected int elapsedToCreateSnapshot

archiverTask

protected TimerTask archiverTask

autoPause

protected TimerTask autoPause

server

protected OEnterpriseServer server

paused

protected AtomicBoolean paused

timestamp

protected AtomicLong timestamp

profilerListeners

protected Set<OEnterpriseProfilerListener> profilerListeners

Constructor Details

OEnterpriseProfiler

public OEnterpriseProfiler()

OEnterpriseProfiler

public OEnterpriseProfiler(int iElapsedToCreateSnapshot,
 OAbstractProfiler iParentProfiler,
 OEnterpriseServer server)

Method Details

configure

public void configure(String iConfiguration)

Specified by:

configure in interface OProfiler

shutdown

public void shutdown()

Specified by:

shutdown in interface OService

Overrides:

shutdown in class OAbstractProfiler

setTip

protected void setTip(String iMessage,
 AtomicInteger counter)

Specified by:

setTip in class OAbstractProfiler

getTip

protected AtomicInteger getTip(String iMessage)

Specified by:

getTip in class OAbstractProfiler

getContext

public ODocument getContext()

Specified by:

getContext in interface OProfiler

startRecording

public boolean startRecording()

Specified by:

startRecording in interface OProfiler

Specified by:

startRecording in interface OProfilerMXBean

Overrides:

startRecording in class OAbstractProfiler

stopRecording

public boolean stopRecording()

Specified by:

stopRecording in interface OProfiler

Specified by:

stopRecording in interface OProfilerMXBean

Overrides:

stopRecording in class OAbstractProfiler

updateCounter

public void updateCounter(String iName,
 String iDescription,
 long iPlus)

Specified by:

updateCounter in interface OProfiler

Overrides:

updateCounter in class OAbstractProfiler

updateCounter

public void updateCounter(String iName,
 String iDescription,
 long iPlus,
 String iMetadata)

Specified by:

updateCounter in interface OProfiler

getCounter

public long getCounter(String iStatName)

Specified by:

getCounter in interface OProfiler

Specified by:

getCounter in interface OProfilerMXBean

isEnterpriseEdition

public boolean isEnterpriseEdition()

Specified by:

isEnterpriseEdition in interface OProfiler

resetRealtime

public void resetRealtime(String iText)

Specified by:

resetRealtime in interface OProfiler

Specified by:

resetRealtime in interface OProfilerMXBean

dump

public void dump(PrintStream printStream)

Specified by:

dump in interface OProfiler

Overrides:

dump in class OAbstractProfiler

toJSON

public String toJSON(String iQuery,
 String iPar1)

Specified by:

toJSON in interface OProfiler

Overrides:

toJSON in class OAbstractProfiler

metadataToJSON

public String metadataToJSON()

Specified by:

metadataToJSON in interface OProfiler

Specified by:

metadataToJSON in interface OProfilerMXBean

Overrides:

metadataToJSON in class OAbstractProfiler

dump

public String dump()

Specified by:

dump in interface OProfiler

Specified by:

dump in interface OProfilerMXBean

Overrides:

dump in class OAbstractProfiler

startChrono

public long startChrono()

Specified by:

startChrono in interface OProfiler

Overrides:

startChrono in class OAbstractProfiler

registerProfilerListener

public void registerProfilerListener(OEnterpriseProfilerListener listener)

unregisterProfilerListener

public void unregisterProfilerListener(OEnterpriseProfilerListener listener)

stopChrono

public long stopChrono(String iName,
 String iDescription,
 long iStartTime)

Specified by:

stopChrono in interface OProfiler

Overrides:

stopChrono in class OAbstractProfiler

stopChrono

public long stopChrono(String iName,
 String iDescription,
 long iStartTime,
 String iDictionaryName)

Specified by:

stopChrono in interface OProfiler

Overrides:

stopChrono in class OAbstractProfiler

stopChrono

public long stopChrono(String iName,
 String iDescription,
 long iStartTime,
 String iDictionaryName,
 String iPayload)

Specified by:

stopChrono in interface OProfiler

stopChrono

public long stopChrono(String iName,
 String iDescription,
 long iStartTime,
 String iDictionaryName,
 String iPayload,
 String user)

Specified by:

stopChrono in interface OProfiler

updateStat

public long updateStat(String iName,
 String iDescription,
 long iValue)

dumpCounters

public String dumpCounters()

Specified by:

dumpCounters in interface OProfiler

Specified by:

dumpCounters in interface OProfilerMXBean

Overrides:

dumpCounters in class OAbstractProfiler

dumpChronos

public String dumpChronos()

Specified by:

dumpChronos in interface OProfiler

Specified by:

dumpChronos in interface OProfilerMXBean

Overrides:

dumpChronos in class OAbstractProfiler

dumpStats

public String dumpStats()

dumpHookValues

public String dumpHookValues()

getHookValue

public Object getHookValue(String iName)

Specified by:

getHookValue in interface OProfiler

getCountersAsString

public String[] getCountersAsString()

Specified by:

getCountersAsString in interface OProfiler

Specified by:

getCountersAsString in interface OProfilerMXBean

Overrides:

getCountersAsString in class OAbstractProfiler

getStatsAsString

public String[] getStatsAsString()

getLastReset

public Date getLastReset()

Specified by:

getLastReset in interface OProfiler

Specified by:

getLastReset in interface OProfilerMXBean

Overrides:

getLastReset in class OAbstractProfiler

getCounters

public List<String> getCounters()

getStat

public OProfilerEntry getStat(String iStatName)

getChronos

public List<String> getChronos()

Specified by:

getChronos in interface OProfiler

getChrono

public OProfilerEntry getChrono(String iChronoName)

Specified by:

getChrono in interface OProfiler

Overrides:

getChrono in class OAbstractProfiler

setAutoDump

public void setAutoDump(int iSeconds)

Specified by:

setAutoDump in interface OProfiler

Specified by:

setAutoDump in interface OProfilerMXBean

Overrides:

setAutoDump in class OAbstractProfiler

archiveHooks

protected Map<String,OAbstractProfiler.OProfilerHookStatic> archiveHooks()

Must be not called inside a lock.

getStatsAsJson

public String getStatsAsJson()

Specified by:

getStatsAsJson in interface OProfiler

updateStats

public void updateStats()

cpuUsage

public double cpuUsage()

cpuUsageFallback

public double cpuUsageFallback()

onNodeJoining

public boolean onNodeJoining(String iNode)

Description copied from interface: ODistributedLifecycleListener

Called when a node is joining the cluster. Return false to deny the join.

Specified by:

onNodeJoining in interface ODistributedLifecycleListener

Parameters:

iNode - Node name that is joining

Returns:

true to allow the join, otherwise false

onNodeJoined

public void onNodeJoined(String iNode)

Description copied from interface: ODistributedLifecycleListener

Called right after a node joined the cluster.

Specified by:

onNodeJoined in interface ODistributedLifecycleListener

Parameters:

iNode - Node name that is joining

onNodeLeft

public void onNodeLeft(String iNode)

Description copied from interface: ODistributedLifecycleListener

Called right after a node left the cluster.

Specified by:

onNodeLeft in interface ODistributedLifecycleListener

Parameters:

iNode - Node name that left

onDatabaseChangeStatus

public void onDatabaseChangeStatus(String iNode,
 String iDatabaseName,
 ODistributedServerManager.DB_STATUS iNewStatus)

Description copied from interface: ODistributedLifecycleListener

Called upon change of database status on a node. Available statuses are defined in ODistributedServerManager.DB_STATUS.

Specified by:

onDatabaseChangeStatus in interface ODistributedLifecycleListener

Parameters:

iNode - The node name

iDatabaseName - Database name

iNewStatus - The new status