org.apache.oozie.util
Class Instrumentation

java.lang.Object
  org.apache.oozie.util.Instrumentation

public class Instrumentation
extends java.lang.Object

Instrumentation framework that supports Timers, Counters, Variables and Sampler instrumentation elements.

All instrumentation elements have a group and a name.

Nested Class Summary

static class	Instrumentation.Cron Cron is a stopwatch that can be started/stopped several times.
static interface	Instrumentation.Element<T> Gives access to a snapshot of an Instrumentation element (Counter, Timer).
static class	Instrumentation.Timer Timer Instrumentation element.
static interface	Instrumentation.Variable<T> Interface for instrumentation variables.

Constructor Summary

Instrumentation()
Instrumentation constructor.

Method Summary

void	addCron(java.lang.String group, java.lang.String name, Instrumentation.Cron cron) Add a cron to an instrumentation timer.
void	addSampler(java.lang.String group, java.lang.String name, int period, int interval, Instrumentation.Variable<java.lang.Long> variable) Add a sampling variable.
void	addVariable(java.lang.String group, java.lang.String name, Instrumentation.Variable variable) Add an instrumentation variable.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>>	getAll() Return a map containing all variables, counters and timers.
java.util.Map<java.lang.String,java.lang.String>	getConfiguration() Return the current system configuration as a Map.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,Instrumentation.Element<java.lang.Long>>>	getCounters() Return all the counters.
java.util.Map<java.lang.String,java.lang.String>	getJavaSystemProperties() Return the JVM system properties.
java.util.Map<java.lang.String,java.lang.String>	getOSEnv() Return the OS environment used to start Oozie.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,Instrumentation.Element<java.lang.Double>>>	getSamplers() Return all the samplers.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,Instrumentation.Element<Instrumentation.Timer>>>	getTimers() Return all the timers.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,Instrumentation.Element<Instrumentation.Variable>>>	getVariables() Return all the variables.
void	incr(java.lang.String group, java.lang.String name, long count) Increment an instrumentation counter.
void	setConfiguration(org.apache.hadoop.conf.Configuration configuration) Set the system configuration.
void	setScheduler(java.util.concurrent.ScheduledExecutorService scheduler) Set the scheduler instance to handle the samplers.
java.lang.String	toString() Return the string representation of the instrumentation.

Methods inherited from class java.lang.Object

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

Constructor Detail

Instrumentation

public Instrumentation()

Instrumentation constructor.

Method Detail

setScheduler

public void setScheduler(java.util.concurrent.ScheduledExecutorService scheduler)

Set the scheduler instance to handle the samplers.

Parameters:

scheduler - scheduler instance.

addCron

public void addCron(java.lang.String group,
                    java.lang.String name,
                    Instrumentation.Cron cron)

Add a cron to an instrumentation timer. The timer is created if it does not exists.

This method is thread safe.

Parameters:

group - timer group.

name - timer name.

cron - cron to add to the timer.

incr

public void incr(java.lang.String group,
                 java.lang.String name,
                 long count)

Increment an instrumentation counter. The counter is created if it does not exists.

This method is thread safe.

Parameters:

group - counter group.

name - counter name.

count - increment to add to the counter.

addVariable

public void addVariable(java.lang.String group,
                        java.lang.String name,
                        Instrumentation.Variable variable)

Add an instrumentation variable. The variable must not exist.

This method is thread safe.

Parameters:

group - counter group.

name - counter name.

variable - variable to add.

setConfiguration

public void setConfiguration(org.apache.hadoop.conf.Configuration configuration)

Set the system configuration.

Parameters:

configuration - system configuration.

getJavaSystemProperties

public java.util.Map<java.lang.String,java.lang.String> getJavaSystemProperties()

Return the JVM system properties.

Returns:

JVM system properties.

getOSEnv

public java.util.Map<java.lang.String,java.lang.String> getOSEnv()

Return the OS environment used to start Oozie.

Returns:

the OS environment used to start Oozie.

getConfiguration

public java.util.Map<java.lang.String,java.lang.String> getConfiguration()

Return the current system configuration as a Map.

Returns:

the current system configuration as a Map.

getCounters

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,Instrumentation.Element<java.lang.Long>>> getCounters()

Return all the counters.

This method is thread safe.

The counters are live. The counter value is a snapshot at the time the Instrumentation.Element.getValue() is invoked.

Returns:

all counters.

getTimers

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,Instrumentation.Element<Instrumentation.Timer>>> getTimers()

Return all the timers.

This method is thread safe.

The timers are live. Once a timer is obtained, all its values are consistent (they are snapshot at the time the Instrumentation.Element.getValue() is invoked.

Returns:

all counters.

getVariables

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,Instrumentation.Element<Instrumentation.Variable>>> getVariables()

Return all the variables.

This method is thread safe.

The variables are live. The variable value is a snapshot at the time the Instrumentation.Element.getValue() is invoked.

Returns:

all counters.

getAll

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>>> getAll()

Return a map containing all variables, counters and timers.

Returns:

a map containing all variables, counters and timers.

toString

public java.lang.String toString()

Return the string representation of the instrumentation.

Overrides:

toString in class java.lang.Object

Returns:

the string representation of the instrumentation.

addSampler

public void addSampler(java.lang.String group,
                       java.lang.String name,
                       int period,
                       int interval,
                       Instrumentation.Variable<java.lang.Long> variable)

Add a sampling variable.

This method is thread safe.

Parameters:

group - timer group.

name - timer name.

period - sampling period to compute rate.

interval - sampling frequency, how often the variable is probed.

variable - variable to sample.

getSamplers

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,Instrumentation.Element<java.lang.Double>>> getSamplers()

Return all the samplers.

This method is thread safe.

The samplers are live. The sampler value is a snapshot at the time the Instrumentation.Element.getValue() is invoked.

Returns:

all counters.