gov.nist.javax.sip.stack

Class CallAnalyzer

java.lang.Object

gov.nist.javax.sip.stack.CallAnalyzer

public class CallAnalyzer
extends Object

This class is a simple thread analysis utility which tracks the time each request is stuck inside a JAIN SIP thread. It also runs periodic audits. If a request is stuck for too long a thread dump is logged. The parameters are specified in the MetricAnalysisConfiguration class and is dynamically reconfigurable. All fields are public without getters and setters for performance. Most of the synchronization is achieved without locks

Author:

Vladimir Ralev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CallAnalyzer.MetricAnalysisConfiguration This is the configuration for the analysis task.
static class	CallAnalyzer.MetricReference This is just a name for certain statistic item.
static class	CallAnalyzer.MetricReferenceMap
static class	CallAnalyzer.StackTrace
static class	CallAnalyzer.ThreadInfo
static class	CallAnalyzer.TImeMetricInfo

Constructor Summary

Constructors

Constructor and Description
CallAnalyzer()
CallAnalyzer(SipStackImpl stack)

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(CallAnalyzer.MetricReference ref, CallAnalyzer.MetricAnalysisConfiguration config) Call this method to reconfigure the given metric
void	enter(CallAnalyzer.MetricReference metricReference) Enter a traced zone by the name of metricReference for the current thread.
void	enter(Thread threadId, CallAnalyzer.MetricReference metricReference) Enter a traced zone by the name of metricReference for the specified thread.
HashMap<CallAnalyzer.MetricReference,Object>	getAttributes(Thread threadId)
String	getCurrentStack(Thread thread) Current stacktrace of the thread
CallAnalyzer.TImeMetricInfo	getMetricStats(CallAnalyzer.MetricReference ref) Get the current stats for the metric over all threads
int	getNumberOfThreads() Number of threads that are executing requests right now or have executed requests and are idle and not garbage collected.
Object	getObject(Thread threadId, String objectName) Retrieve items associated with the thread
String	getThreadDump() Returns the stacktraces of all threads
Long	getTime(Thread threadId, CallAnalyzer.MetricReference metricReference)
boolean	isAnalysisStarted(CallAnalyzer.MetricReference ref) If the startAnalysis method was called and not stopped
void	leave(CallAnalyzer.MetricReference metricReference) Leave a traced zone by the name of metricReference for the specified thread.
void	leave(Thread threadId, CallAnalyzer.MetricReference metricReference) Leave a traced zone by the name of metricReference for the specifed thread.
static void	main(String[] arg)
void	resetStats(CallAnalyzer.MetricReference metricReference) Rest all stats and start over with sum, average, etc
void	setObject(Thread threadId, CallAnalyzer.MetricReference objectName, Object object) You can associate Objects for a given thread and display them later for more analysis items.
void	startAnalysis(CallAnalyzer.MetricReference metricReference) Start the analysis job that will check the status of the requests periodically and make thread dumps if some request is stuck.
void	stop() Stop everything
void	stopAnalysis(CallAnalyzer.MetricReference metricReference) Stop the analysis for a given metric, the analysis periodic job will be stopped and stack traces will no longer be produced.

Methods inherited from class java.lang.Object

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

Constructor Detail

CallAnalyzer

public CallAnalyzer(SipStackImpl stack)

CallAnalyzer

public CallAnalyzer()

Method Detail

configure

public void configure(CallAnalyzer.MetricReference ref,
             CallAnalyzer.MetricAnalysisConfiguration config)

Call this method to reconfigure the given metric

Parameters:

ref -

config -

isAnalysisStarted

public boolean isAnalysisStarted(CallAnalyzer.MetricReference ref)

If the startAnalysis method was called and not stopped

Parameters:

ref -

Returns:

getMetricStats

public CallAnalyzer.TImeMetricInfo getMetricStats(CallAnalyzer.MetricReference ref)

Get the current stats for the metric over all threads

Parameters:

ref -

Returns:

resetStats

public void resetStats(CallAnalyzer.MetricReference metricReference)

Rest all stats and start over with sum, average, etc

Parameters:

metricReference -

stopAnalysis

public void stopAnalysis(CallAnalyzer.MetricReference metricReference)

Stop the analysis for a given metric, the analysis periodic job will be stopped and stack traces will no longer be produced.

Parameters:

metricReference -

startAnalysis

public void startAnalysis(CallAnalyzer.MetricReference metricReference)

Start the analysis job that will check the status of the requests periodically and make thread dumps if some request is stuck.

Parameters:

metricReference -

stop

public void stop()

Stop everything

getTime

public Long getTime(Thread threadId,
           CallAnalyzer.MetricReference metricReference)

setObject

public void setObject(Thread threadId,
             CallAnalyzer.MetricReference objectName,
             Object object)

You can associate Objects for a given thread and display them later for more analysis items.

Parameters:

threadId -

objectName -

object -

getObject

public Object getObject(Thread threadId,
               String objectName)

Retrieve items associated with the thread

Parameters:

threadId -

objectName -

Returns:

getAttributes

public HashMap<CallAnalyzer.MetricReference,Object> getAttributes(Thread threadId)

enter

public void enter(CallAnalyzer.MetricReference metricReference)

Enter a traced zone by the name of metricReference for the current thread. This puts the enter timestamp and all lost call calculations will be based on this timestamp

Parameters:

threadId -

metricReference -

leave

public void leave(CallAnalyzer.MetricReference metricReference)

Leave a traced zone by the name of metricReference for the specified thread. This puts the timestamp in inactive mode. No more analysis will be done on this thread.

Parameters:

threadId -

metricReference -

enter

public void enter(Thread threadId,
         CallAnalyzer.MetricReference metricReference)

Enter a traced zone by the name of metricReference for the specified thread. This puts the enter timestamp and all lost call calculations will be based on this timestamp.

Parameters:

threadId -

metricReference -

leave

public void leave(Thread threadId,
         CallAnalyzer.MetricReference metricReference)

Leave a traced zone by the name of metricReference for the specifed thread. No more analysis will be done on this thread.

Parameters:

threadId -

metricReference -

getCurrentStack

public String getCurrentStack(Thread thread)

Current stacktrace of the thread

Parameters:

thread -

Returns:

getThreadDump

public String getThreadDump()

Returns the stacktraces of all threads

Returns:

getNumberOfThreads

public int getNumberOfThreads()

Number of threads that are executing requests right now or have executed requests and are idle and not garbage collected. You can check for leaks here.

Returns:

main

public static void main(String[] arg)
                 throws InterruptedException

Throws:

InterruptedException