Metric.Metric Class Reference

Metrics are variables which can archive. More...

Inheritance diagram for Metric.Metric:

Public Member Functions
def	__init__ (self, name, history=0, archive=True, batch=10)
def	getInfo (self)
def	value (self)
def	value (self, value)
def	hotValues (self)
def	clearValues (self)
def	loadValues (self, start=None, end=None, resolution='hour')
def	hasValues (self, start, end)

Static Public Member Functions
def	getIndex ()
def	index (force=False)

Public Attributes
	name
	history
	now

Detailed Description

Metrics are variables which can archive.

Constructor & Destructor Documentation

__init__()

def Metric.Metric.__init__	(		self,
			name,
			history = 0,
			archive = True,
			batch = 10
	)

Initializes a Metric object
A metric is like a variable but it collects changes and saves them in batches to an archive in CSV format. Older archives are compressed and added to cold storage.
This was designed to have as smaller footprint on CPU and RAM as possible while still recording every historic value

@param name - should be unique to each instance of the Metric class - characters which cannot be used as directory names will be stripped or replaced
@param history - the amount of time in milliseconds used to retain values in memory. 0 = no previous values, -1 = all previous values, 1000 = the last seconds worth
@param archive - create an archive of historic values for later examination
@param batch

Member Function Documentation

clearValues()

def Metric.Metric.clearValues

(

self

)

empties the list of values
metric.clearValues()

getIndex()

def Metric.Metric.getIndex ( )

static

gets the complete metrics index

@return dict

getInfo()

def Metric.Metric.getInfo

(

self

)

get metric info

@return dict

hasValues()

def Metric.Metric.hasValues	(		self,
			start,
			end
	)

check for valies in time range

@param start
@param end

@return bool

hotValues()

def Metric.Metric.hotValues

(

self

)

gets all values in memory
x = metric.hotValues()

@return list

index()

def Metric.Metric.index (   force = False )

static

internal use only
indexes archive names and temperature (hot/cold) by date

@param force

loadValues()

def Metric.Metric.loadValues	(		self,
			start = None,
			end = None,
			resolution = 'hour'
	)

load historic values for this metric between the given times
metric.loadValues(time.time(),time.time())
start - time.time() float - seconds since unix epoc (subtract seconds for earlier values)
end - time.time() float - seconds since unix epoc (subtract seconds for earlier values)

@param start
@param end
@param resolution

value() [1/2]

def Metric.Metric.value

(

self

)

gets the most up to date value of this metric
usage: x = metric.value

@return value

value() [2/2]

def Metric.Metric.value	(		self,
			value
	)

sets the most up to date value and performs maintenance
metric.value = x

---

The documentation for this class was generated from the following file:

• Metric.py