hudson.model
Class MultiStageTimeSeries

java.lang.Object
  hudson.model.MultiStageTimeSeries

@ExportedBean
public class MultiStageTimeSeries
extends Object

Maintains several TimeSeries with different update frequencies to satisfy three goals; (1) retain data over long timespan, (2) save memory, and (3) retain accurate data for the recent past. All in all, one instance uses about 8KB space.

Author:

Kohsuke Kawaguchi

Nested Class Summary

static class	MultiStageTimeSeries.TimeScale Choose which datapoint to use.
static class	MultiStageTimeSeries.TrendChart Represents the trend chart that consists of several MultiStageTimeSeries.

Field Summary

Color	color Used to render a line in the trend chart.
hudson.model.TimeSeries	hour Updated every 1 hour.
hudson.model.TimeSeries	min Updated every 1 min.
hudson.model.TimeSeries	sec10 Updated every 10 seconds.
org.jvnet.localizer.Localizable	title Name of this data series.

Constructor Summary

MultiStageTimeSeries(float initialValue, float decay)
Deprecated. since 2009-04-05. Use MultiStageTimeSeries(Localizable, Color, float, float)

MultiStageTimeSeries(org.jvnet.localizer.Localizable title, Color color, float initialValue, float decay)

Method Summary

static MultiStageTimeSeries.TrendChart	createTrendChart(MultiStageTimeSeries.TimeScale scale, MultiStageTimeSeries... data)
hudson.model.Api	getApi()
Color	getColor()
hudson.model.TimeSeries	getHour()
float	getLatest(MultiStageTimeSeries.TimeScale timeScale) Gets the most up-to-date data point value.
hudson.model.TimeSeries	getMin()
hudson.model.TimeSeries	getSec10()
org.jvnet.localizer.Localizable	getTitle()
hudson.model.TimeSeries	pick(MultiStageTimeSeries.TimeScale timeScale) Selects a TimeSeries.
void	update(float f) Call this method every 10 sec and supply a new data point.

Methods inherited from class java.lang.Object

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

Field Detail

title

public final org.jvnet.localizer.Localizable title

Name of this data series.

color

public final Color color

Used to render a line in the trend chart.

sec10

@Exported
public final hudson.model.TimeSeries sec10

Updated every 10 seconds. Keep data up to 1 hour.

min

@Exported
public final hudson.model.TimeSeries min

Updated every 1 min. Keep data up to 1 day.

hour

@Exported
public final hudson.model.TimeSeries hour

Updated every 1 hour. Keep data up to 4 weeks.

Constructor Detail

MultiStageTimeSeries

public MultiStageTimeSeries(org.jvnet.localizer.Localizable title,
                            Color color,
                            float initialValue,
                            float decay)

MultiStageTimeSeries

public MultiStageTimeSeries(float initialValue,
                            float decay)

Deprecated. since 2009-04-05. Use MultiStageTimeSeries(Localizable, Color, float, float)

Method Detail

getTitle

public org.jvnet.localizer.Localizable getTitle()

getColor

public Color getColor()

getSec10

public hudson.model.TimeSeries getSec10()

getMin

public hudson.model.TimeSeries getMin()

getHour

public hudson.model.TimeSeries getHour()

update

public void update(float f)

Call this method every 10 sec and supply a new data point.

pick

public hudson.model.TimeSeries pick(MultiStageTimeSeries.TimeScale timeScale)

Selects a TimeSeries.

getLatest

public float getLatest(MultiStageTimeSeries.TimeScale timeScale)

Gets the most up-to-date data point value.

getApi

public hudson.model.Api getApi()

createTrendChart

public static MultiStageTimeSeries.TrendChart createTrendChart(MultiStageTimeSeries.TimeScale scale,
                                                               MultiStageTimeSeries... data)