Package org.apache.hop.pipeline.engine

Class EngineMetrics

java.lang.Object

org.apache.hop.pipeline.engine.EngineMetrics

public class EngineMetrics
extends Object

Describes the metrics you can get from an execution engine

Constructor Summary

Constructors

Constructor	Description
EngineMetrics()

Method Summary

Modifier and Type	Method	Description
void	addCompomentPerformanceSnapShot(IEngineComponent component, PerformanceSnapShot snapShot)
void	addComponent(IEngineComponent component)
Long	getComponentMetric(IEngineComponent component, IEngineMetric metric)	Retrieve the amount for a specific metric
Map<IEngineComponent,Map<IEngineMetric,Long>>	getComponentMetricsMap()	Gets componentMetricsMap
Map<IEngineComponent,List<PerformanceSnapShot>>	getComponentPerformanceSnapshots()	Gets componentPerformanceSnapshots
Map<IEngineComponent,Boolean>	getComponentRunningMap()	Gets componentRunningMap
List<IEngineComponent>	getComponents()	Gets components
Map<IEngineComponent,String>	getComponentSpeedMap()	Gets componentSpeedMap
Map<IEngineComponent,String>	getComponentStatusMap()	Gets componentStatusMap
Date	getEndDate()	Gets endDate
Set<IEngineMetric>	getMetricsList()	Get a list of the used metrics
Date	getStartDate()	Gets startDate
void	incrementComponentMetric(IEngineComponent component, IEngineMetric metric)	Increment the amount for a specific metric (+1).
Long	removeComponentMetric(IEngineComponent component, IEngineMetric metric)	Remove the amount for a specific metric
void	setComponentMetric(IEngineComponent component, IEngineMetric metric, Long amount)
void	setComponentMetricsMap(Map<IEngineComponent,Map<IEngineMetric,Long>> componentMetricsMap)
void	setComponentPerformanceSnapshots(Map<IEngineComponent,List<PerformanceSnapShot>> componentPerformanceSnapshots)
void	setComponentRunning(IEngineComponent component, Boolean running)
void	setComponentRunningMap(Map<IEngineComponent,Boolean> componentRunningMap)
void	setComponents(List<IEngineComponent> components)
void	setComponentSpeed(IEngineComponent component, String status)
void	setComponentSpeedMap(Map<IEngineComponent,String> componentSpeedMap)
void	setComponentStatus(IEngineComponent component, String status)
void	setComponentStatusMap(Map<IEngineComponent,String> componentStatusMap)
void	setEndDate(Date endDate)
void	setStartDate(Date startDate)

Methods inherited from class java.lang.Object

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

Constructor Detail

EngineMetrics

public EngineMetrics()

Method Detail

getMetricsList

public Set<IEngineMetric> getMetricsList()

Get a list of the used metrics

Returns:

The list of used metrics

addComponent

public void addComponent(IEngineComponent component)

setComponentMetric

public void setComponentMetric(IEngineComponent component,
                               IEngineMetric metric,
                               Long amount)

Parameters:

component - The component to set a metric for (e.g. transform name)

metric - The metric (e.g. input, output, ...)

amount - the metric amount

setComponentStatus

public void setComponentStatus(IEngineComponent component,
                               String status)

setComponentSpeed

public void setComponentSpeed(IEngineComponent component,
                              String status)

setComponentRunning

public void setComponentRunning(IEngineComponent component,
                                Boolean running)

getComponentMetric

public Long getComponentMetric(IEngineComponent component,
                               IEngineMetric metric)

Retrieve the amount for a specific metric

Parameters:

component - The component of the metric (e.g. transform name)

metric - The metric (e.g. input, output, ...)

Returns:

the metric amount or null if nothing was found

incrementComponentMetric

public void incrementComponentMetric(IEngineComponent component,
                                     IEngineMetric metric)

Increment the amount for a specific metric (+1). If the metric didn't exist create it and set it to 1.

Parameters:

component - The component of the metric (e.g. transform name)

metric - The metric (e.g. input, output, ...)

removeComponentMetric

public Long removeComponentMetric(IEngineComponent component,
                                  IEngineMetric metric)

Remove the amount for a specific metric

Parameters:

component - The component of the metric (e.g. transform name)

metric - The name of the metric (e.g. input, output, ...)

Returns:

the metric amount or null if nothing stored in the first place

addCompomentPerformanceSnapShot

public void addCompomentPerformanceSnapShot(IEngineComponent component,
                                            PerformanceSnapShot snapShot)

getStartDate

public Date getStartDate()

Gets startDate

Returns:

value of startDate

setStartDate

public void setStartDate(Date startDate)

Parameters:

startDate - The startDate to set

getEndDate

public Date getEndDate()

Gets endDate

Returns:

value of endDate

setEndDate

public void setEndDate(Date endDate)

Parameters:

endDate - The endDate to set

getComponentMetricsMap

public Map<IEngineComponent,Map<IEngineMetric,Long>> getComponentMetricsMap()

Gets componentMetricsMap

Returns:

value of componentMetricsMap

setComponentMetricsMap

public void setComponentMetricsMap(Map<IEngineComponent,Map<IEngineMetric,Long>> componentMetricsMap)

Parameters:

componentMetricsMap - The componentMetricsMap to set

getComponentStatusMap

public Map<IEngineComponent,String> getComponentStatusMap()

Gets componentStatusMap

Returns:

value of componentStatusMap

setComponentStatusMap

public void setComponentStatusMap(Map<IEngineComponent,String> componentStatusMap)

Parameters:

componentStatusMap - The componentStatusMap to set

getComponentSpeedMap

public Map<IEngineComponent,String> getComponentSpeedMap()

Gets componentSpeedMap

Returns:

value of componentSpeedMap

setComponentSpeedMap

public void setComponentSpeedMap(Map<IEngineComponent,String> componentSpeedMap)

Parameters:

componentSpeedMap - The componentSpeedMap to set

getComponentRunningMap

public Map<IEngineComponent,Boolean> getComponentRunningMap()

Gets componentRunningMap

Returns:

value of componentRunningMap

setComponentRunningMap

public void setComponentRunningMap(Map<IEngineComponent,Boolean> componentRunningMap)

Parameters:

componentRunningMap - The componentRunningMap to set

getComponents

public List<IEngineComponent> getComponents()

Gets components

Returns:

value of components

setComponents

public void setComponents(List<IEngineComponent> components)

Parameters:

components - The components to set

getComponentPerformanceSnapshots

public Map<IEngineComponent,List<PerformanceSnapShot>> getComponentPerformanceSnapshots()

Gets componentPerformanceSnapshots

Returns:

value of componentPerformanceSnapshots

setComponentPerformanceSnapshots

public void setComponentPerformanceSnapshots(Map<IEngineComponent,List<PerformanceSnapShot>> componentPerformanceSnapshots)

Parameters:

componentPerformanceSnapshots - The componentPerformanceSnapshots to set