jrds

Class Probe<KeyType,ValueType>

java.lang.Object

jrds.starter.StarterNode

jrds.Probe<KeyType,ValueType>

All Implemented Interfaces:

Comparable<Probe<KeyType,ValueType>>, StartersSet

Direct Known Subclasses:

ContainerProbe, ExternalCmdProbe, HttpProbe, JdbcProbe, Ntp, ProbeConnected, Ribcl, RRDToolProbe, RstatProbe3, RstatProbe4, Varnish

public abstract class Probe<KeyType,ValueType>
extends StarterNode
implements Comparable<Probe<KeyType,ValueType>>

A abstract class that needs to be derived for specific probe.
the derived class must construct a ProbeDesc and can overid some method as needed

Author:

Fabrice Bacchella

Constructor Summary

Constructors

Constructor and Description
Probe() A special case constructor, mainly used by virtual probe
Probe(ProbeDesc pd) A special case constructor, mainly used by virtual probe

Method Summary

Methods

Modifier and Type	Method and Description
void	addGraph(GraphDesc gd)
void	addGraph(GraphNode node)
boolean	checkStore() Check the final status of the probe.
protected boolean	checkStoreFile()
void	collect() Launch an collect of values.
int	compareTo(Probe<KeyType,ValueType> arg0) The comparaison order of two object of the class is a case insensitive comparaison of it's string value.
protected void	create() Create the probe file
boolean	dsExist(String dsName)
Document	dumpAsXml()
Document	dumpAsXml(boolean sorted)
FetchData	fetchData(ConsolFun consolFun, long fetchStart, long fetchEnd, long resolution) Return the probe data for the given period
FetchData	fetchData(Date startDate, Date endDate) Return the probe data for the given period
FetchData	fetchData(long fetchStart, long fetchEnd) Return the probe data for the given period
Map<KeyType,Number>	filterValues(Map<KeyType,ValueType> valuesList) This method convert the collected object to numbers and can do post treatment
Map<KeyType,String>	getCollectMapping()
protected DsDef[]	getDsDefs()
Collection<GraphNode>	getGraphList()
HostInfo	getHost()
String	getLabel()
Date	getLastUpdate() Return the date of the last update of the rrd backend
Map<String,Number>	getLastValues()
String	getName()
Logger	getNamedLogger()
abstract Map<KeyType,ValueType>	getNewSampleValues() The method that return a map of data collected. It should return return as raw as possible, they can even be opaque data tied to the probe.
ProbeDesc	getPd()
String	getQualifiedName() Return a unique name for the graph
RrdDef	getRrdDef()
String	getRrdName()
abstract String	getSourceType()
Set<String>	getTags()
long	getUptime() This function should return the uptime of the probe If it's not overriden or fixed with setUptime, it will return Long.MAX_VALUE that's make it useless, as it used to make the probe pause after a restart of the probe.
int	hashCode()
void	log(Level l, String format, Object... elements)
void	log(Level l, Throwable e, String format, Object... elements)
void	modifySample(Sample oneSample, Map<KeyType,ValueType> values) The sample itself can be modified
void	readProperties(PropertiesManager pm) A probe can override it to extract custom values from the properties.
boolean	readSpecific() This function it used by the probe to read all the specific it needs from the probe description It's called once during the probe initialization Every override should finish by: return super();
void	setHost(HostStarter monitoredHost)
void	setLabel(String label)
void	setName(String name)
void	setPd(ProbeDesc pd)
void	setUptime(long uptime) Define the uptime of the probe
String	toString() Return the string value of the probe as a path constitued of the host name / the probe name

Methods inherited from class jrds.starter.StarterNode

configureStarters, find, find, find, find, find, getHostList, getLevel, getParent, getStarters, getStep, getTimeout, isCollectRunning, isStarted, registerStarter, registerStarter, setParent, setParent, setStep, setTimeout, startCollect, stopCollect

Methods inherited from class java.lang.Object

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

Constructor Detail

Probe

public Probe(ProbeDesc pd)

A special case constructor, mainly used by virtual probe

Parameters:

monitoredHost -

pd -

Probe

public Probe()

A special case constructor, mainly used by virtual probe

Parameters:

monitoredHost -

pd -

Method Detail

getHost

public HostInfo getHost()

setHost

public void setHost(HostStarter monitoredHost)

setPd

public void setPd(ProbeDesc pd)

addGraph

public void addGraph(GraphDesc gd)

addGraph

public void addGraph(GraphNode node)

getGraphList

public Collection<GraphNode> getGraphList()

Returns:

Returns the graphList.

getName

public String getName()

setName

public void setName(String name)

getRrdName

public String getRrdName()

getDsDefs

protected DsDef[] getDsDefs()

getRrdDef

public RrdDef getRrdDef()

create

protected void create()
               throws IOException

Create the probe file

Throws:

IOException

checkStore

public boolean checkStore()

Check the final status of the probe. It must be called once before an probe can be used Open the rrd backend of the probe. it's created if it's needed

Throws:

IOException

RrdException

checkStoreFile

protected boolean checkStoreFile()

getNewSampleValues

public abstract Map<KeyType,ValueType> getNewSampleValues()

The method that return a map of data collected.
It should return return as raw as possible, they can even be opaque data tied to the probe. the key is resolved using the ProbeDesc. A key not associated with an existent datastore will generate a warning but will not prevent the other values to be stored.

Returns:

the map of collected object or null if the collect failed

filterValues

public Map<KeyType,Number> filterValues(Map<KeyType,ValueType> valuesList)

This method convert the collected object to numbers and can do post treatment

Parameters:

valuesList -

Returns:

an map of value to be stored

modifySample

public void modifySample(Sample oneSample,
                Map<KeyType,ValueType> values)

The sample itself can be modified

Parameters:

oneSample -

values -

getCollectMapping

public Map<KeyType,String> getCollectMapping()

collect

public void collect()

Launch an collect of values. You should not try to override it

toString

public String toString()

Return the string value of the probe as a path constitued of the host name / the probe name

Overrides:

toString in class Object

See Also:

Object.toString()

compareTo

public int compareTo(Probe<KeyType,ValueType> arg0)

The comparaison order of two object of the class is a case insensitive comparaison of it's string value.

Specified by:

compareTo in interface Comparable<Probe<KeyType,ValueType>>

Parameters:

arg0 - Object

Returns:

int

getPd

public ProbeDesc getPd()

Returns:

Returns the ProbeDesc of the probe.

getLastUpdate

public Date getLastUpdate()

Return the date of the last update of the rrd backend

Returns:

The date

dsExist

public boolean dsExist(String dsName)

fetchData

public FetchData fetchData(Date startDate,
                  Date endDate)

Return the probe data for the given period

Parameters:

startDate -

endDate -

Returns:

fetchData

public FetchData fetchData(long fetchStart,
                  long fetchEnd)

Return the probe data for the given period

Parameters:

fetchStart - Starting timestamp for fetch request.

fetchEnd - Ending timestamp for fetch request.

Returns:

Request object that should be used to actually fetch data from RRD

fetchData

public FetchData fetchData(ConsolFun consolFun,
                  long fetchStart,
                  long fetchEnd,
                  long resolution)

Return the probe data for the given period

Parameters:

consolFun - Consolidation function to be used in fetch request. Allowed values are "AVERAGE", "MIN", "MAX" and "LAST" (these constants are conveniently defined in the ConsolFun class).

fetchStart - Starting timestamp for fetch request.

fetchEnd - Ending timestamp for fetch request.

resolution - Fetch resolution.

Returns:

Request object that should be used to actually fetch data from RRD

getLastValues

public Map<String,Number> getLastValues()

getQualifiedName

public String getQualifiedName()

Return a unique name for the graph

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getTags

public Set<String> getTags()

getSourceType

public abstract String getSourceType()

readSpecific

public boolean readSpecific()

This function it used by the probe to read all the specific it needs from the probe description It's called once during the probe initialization Every override should finish by: return super();

Returns:

readProperties

public void readProperties(PropertiesManager pm)

A probe can override it to extract custom values from the properties. It will be read just after it's created and before configuration.

Parameters:

pm -

getUptime

public long getUptime()

This function should return the uptime of the probe If it's not overriden or fixed with setUptime, it will return Long.MAX_VALUE that's make it useless, as it used to make the probe pause after a restart of the probe. It's called after filterValues

Returns:

the uptime in second

setUptime

public void setUptime(long uptime)

Define the uptime of the probe

Parameters:

uptime - in seconds

dumpAsXml

public Document dumpAsXml()
                   throws ParserConfigurationException,
                          IOException

Throws:

ParserConfigurationException

IOException

dumpAsXml

public Document dumpAsXml(boolean sorted)
                   throws ParserConfigurationException,
                          IOException

Throws:

ParserConfigurationException

IOException

getLabel

public String getLabel()

setLabel

public void setLabel(String label)

log

public void log(Level l,
       Throwable e,
       String format,
       Object... elements)

Overrides:

log in class StarterNode

log

public void log(Level l,
       String format,
       Object... elements)

Overrides:

log in class StarterNode

getNamedLogger

public Logger getNamedLogger()

Returns:

the namedLogger