com.microsoft.applicationinsights.internal.perfcounter

Enum PerformanceCounterContainer

java.lang.Object

java.lang.Enum<PerformanceCounterContainer>

com.microsoft.applicationinsights.internal.perfcounter.PerformanceCounterContainer

All Implemented Interfaces:

Stoppable, java.io.Serializable, java.lang.Comparable<PerformanceCounterContainer>

public enum PerformanceCounterContainer
extends java.lang.Enum<PerformanceCounterContainer>
implements Stoppable

The class serves as the container of all PerformanceCounter

If there is a need for a performance counter, the user of this class should create an implementation of that interface and then register it in this container.

Note that the container will only start working after the first registration of a Performance Counter. That means that setting the timeouts is only relevant if done before the first registration of a Performance Counter.

The container will go through all the registered Performance Counters and will trigger their 'report' method. By default the container will start reporting after 5 minutes and will continue doing so every 1 minute.

The user of this class can add (register), remove (unregister) a performance counter while the container is working.

The container will be stopped automatically when the application exists.

Created by gupele on 3/3/2015.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_COLLECTION_FREQUENCY_IN_SEC

Method Summary

Modifier and Type	Method and Description
long	getCollectionFrequencyInSec() Gets the timeout in milliseconds that the container will wait between collections of Performance Counters.
long	getStartCollectingDelayInMillis() Gets the timeout in milliseconds that the container will wait before the first collection of Performance Counters.
boolean	register(PerformanceCounter performanceCounter) /** Registers a PerformanceCounter that can collect data.
void	setCollectionFrequencyInSec(long collectionFrequencyInSec) Sets the timeout to wait between collection of Performance Counters.
void	setPlugin(PerformanceCountersCollectionPlugin plugin)
void	stop(long timeout, java.util.concurrent.TimeUnit timeUnit) Stopping the collection of performance data.
void	unregister(PerformanceCounter performanceCounter) Un-registers a performance counter.
void	unregister(java.lang.String id) Un-registers a performance counter by its id.
static PerformanceCounterContainer	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PerformanceCounterContainer[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final PerformanceCounterContainer INSTANCE

Field Detail

DEFAULT_COLLECTION_FREQUENCY_IN_SEC

public static final long DEFAULT_COLLECTION_FREQUENCY_IN_SEC

See Also:

Constant Field Values

Method Detail

values

public static PerformanceCounterContainer[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PerformanceCounterContainer c : PerformanceCounterContainer.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PerformanceCounterContainer valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

register

public boolean register(PerformanceCounter performanceCounter)

/** Registers a PerformanceCounter that can collect data.

Parameters:

performanceCounter - The Performance Counter.

Returns:

True on success.

unregister

public void unregister(PerformanceCounter performanceCounter)

Un-registers a performance counter.

Parameters:

performanceCounter - The Performance Counter.

unregister

public void unregister(java.lang.String id)

Un-registers a performance counter by its id.

Parameters:

id - The Performance Counter's id.

getStartCollectingDelayInMillis

public long getStartCollectingDelayInMillis()

Gets the timeout in milliseconds that the container will wait before the first collection of Performance Counters.

Returns:

The first timeout in milliseconds.

getCollectionFrequencyInSec

public long getCollectionFrequencyInSec()

Gets the timeout in milliseconds that the container will wait between collections of Performance Counters.

Returns:

The timeout between collections.

stop

public void stop(long timeout,
                 java.util.concurrent.TimeUnit timeUnit)

Stopping the collection of performance data.

Specified by:

stop in interface Stoppable

Parameters:

timeout - The timeout to wait for the stop to happen.

timeUnit - The time unit to use when waiting for the stop to happen.

setCollectionFrequencyInSec

public void setCollectionFrequencyInSec(long collectionFrequencyInSec)

Sets the timeout to wait between collection of Performance Counters.

The number must be a positive number

Note that the method will be effective if called before the first call to the 'register' method.

Parameters:

collectionFrequencyInSec - The timeout to wait between collection of Performance Counters.

setPlugin

public void setPlugin(PerformanceCountersCollectionPlugin plugin)