alma.acs.profiling.orb

Class AcsORBProfilerImplBase

java.lang.Object

alma.acs.profiling.orb.AcsORBProfilerImplBase

Direct Known Subclasses:

ContainerOrbProfiler, ManagerOrbProfiler

public class AcsORBProfilerImplBase
extends java.lang.Object

Profiler implementation that can be used as a base class (or directly) for ORB profiling of containers, manager, OMC etc.

If registered with the ORB, this class will collect ORB callbacks and log statistics every 10 seconds, see checkAndLogStatus().

To get logs for every ORB callback (only available for stdout), use DEBUG_CONFIG_PROPERTYNAME.

Author:

msekoran (first impl as cdb_rdb :: ORBRequestTimer), hsommer

Field Summary

Fields

Modifier and Type	Field and Description
protected int	connectionPoolUsePercent Percentage of busy threads in the connection thread pool.
static java.lang.String	DEBUG_CONFIG_PROPERTYNAME This property can optionally be set to one or more (comma and/or space separated) names of callback methods as defined in AcsORBProfiler, whose invocations will then be printed to stdout in addition to the normal profiling summary statistics that gets logged.
protected boolean	debugConnectionThreadPoolSizeChanged Can be set via DEBUG_CONFIG_PROPERTYNAME.
protected boolean	debugRequestFinished
protected boolean	debugRequestQueueSizeChanged
protected boolean	debugRequestStarted
protected boolean	debugThreadPoolSizeChanged
protected boolean	debugUndeliveredRequest
protected AcsLogger	logger Logger passed in the c'tor.

Constructor Summary

Constructors

Constructor and Description
AcsORBProfilerImplBase(AcsLogger logger)

Method Summary

Modifier and Type	Method and Description
void	connectionThreadPoolSizeChanged(int idleThreads, int totalThreads, int maxThreads)
protected void	logStatus(java.lang.String defaultLogMessage, java.util.logging.Level defaultLogLevel, int connectionPoolUsePercent, int undeliveredRequests, int requestQueueMaxUsePercent, java.lang.String requestQueueMaxUsePOA) This method is broken out from checkAndLogStatus() so that subclasses can change or suppress the log message, without having to worry about log repeat guard or synchronization.
void	requestFinished(int requestId, java.lang.String poaName, java.lang.String operation)
void	requestQueueSizeChanged(int requestId, java.lang.String poaName, int queueSize, int maxQueueLength) Only records the maximum queue length and the POA name owning that queue.
void	requestStarted(int requestId, java.lang.String poaName, java.lang.String operation)
void	threadPoolSizeChanged(java.lang.String poaName, int idleThreads, int totalThreads, int maxThreads)
void	undeliveredRequest(int messageSize, java.lang.String poaName, java.lang.String operation, boolean causedByQueueFull)

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG_CONFIG_PROPERTYNAME

public static final java.lang.String DEBUG_CONFIG_PROPERTYNAME

This property can optionally be set to one or more (comma and/or space separated) names of callback methods as defined in AcsORBProfiler, whose invocations will then be printed to stdout in addition to the normal profiling summary statistics that gets logged.

Example: -Dalma.acs.profiling.orb.debugLogs='requestFinished,undeliveredRequest requestQueueSizeChanged'"

See Also:

Constant Field Values

logger

protected final AcsLogger logger

Logger passed in the c'tor.

connectionPoolUsePercent

protected volatile int connectionPoolUsePercent

Percentage of busy threads in the connection thread pool.

debugConnectionThreadPoolSizeChanged

protected boolean debugConnectionThreadPoolSizeChanged

Can be set via DEBUG_CONFIG_PROPERTYNAME. We convert to explicit booleans instead of string-based lookup to improve performance.

debugUndeliveredRequest

protected boolean debugUndeliveredRequest

debugRequestQueueSizeChanged

protected boolean debugRequestQueueSizeChanged

debugThreadPoolSizeChanged

protected boolean debugThreadPoolSizeChanged

debugRequestStarted

protected boolean debugRequestStarted

debugRequestFinished

protected boolean debugRequestFinished

Constructor Detail

AcsORBProfilerImplBase

public AcsORBProfilerImplBase(AcsLogger logger)

Method Detail

connectionThreadPoolSizeChanged

public void connectionThreadPoolSizeChanged(int idleThreads,
                                            int totalThreads,
                                            int maxThreads)

undeliveredRequest

public void undeliveredRequest(int messageSize,
                               java.lang.String poaName,
                               java.lang.String operation,
                               boolean causedByQueueFull)

requestQueueSizeChanged

public void requestQueueSizeChanged(int requestId,
                                    java.lang.String poaName,
                                    int queueSize,
                                    int maxQueueLength)

Only records the maximum queue length and the POA name owning that queue. For more information, we could record the queue lengths for all POAs, but then have to watch out that the backing map etc structure does not overflow when different POAs come and go.

See Also:

org.jacorb.orb.acs.AcsORBProfiler#requestQueueSizeChanged(int, java.lang.String, int, int)

threadPoolSizeChanged

public void threadPoolSizeChanged(java.lang.String poaName,
                                  int idleThreads,
                                  int totalThreads,
                                  int maxThreads)

requestStarted

public void requestStarted(int requestId,
                           java.lang.String poaName,
                           java.lang.String operation)

requestFinished

public void requestFinished(int requestId,
                            java.lang.String poaName,
                            java.lang.String operation)

logStatus

protected void logStatus(java.lang.String defaultLogMessage,
                         java.util.logging.Level defaultLogLevel,
                         int connectionPoolUsePercent,
                         int undeliveredRequests,
                         int requestQueueMaxUsePercent,
                         java.lang.String requestQueueMaxUsePOA)

This method is broken out from checkAndLogStatus() so that subclasses can change or suppress the log message, without having to worry about log repeat guard or synchronization.

Parameters:

defaultLogMessage - A default log message, that can be used or replaced by another message.

defaultLogLevel - A suggested log level.

connectionPoolUsePercent - See connectionPoolUsePercent. Can be used to build a custom message.

undeliveredRequests - See undeliveredRequests. Can be used to build a custom message.

requestQueueMaxUsePercent - See requestQueueMaxUsePercent. Can be used to build a custom message.

requestQueueMaxUsePOA - See requestQueueMaxUsePOA. Can be used to build a custom message.