Parameter	Type	Description
`$dsname`	`string`	//The name of the data source
`$type`	`string`	//Data source types are: GAUGE, COUNTER, ABSOLUTE
`$min`	`int`	//Minimum allowed value
`$max`	`int`	//Maximum allowed value
`$description`	`string`	//String describing the data source

addArchive

addArchive('day_average', 'AVERAGE', 60, 24);.

public  addArchive({Array})

Parameters

Parameter	Type	Description
`$archiveID`	`string`	Name of the archive
`$cf`	`string`	Consolidation function and can be: AVERAGE, MIN, MAX or LAST
`$ticks`	`int`	Number of ticks to consolidate into a row
`$rows`	`int`	Number of rows to store in the archive
`$description`	`string`	A string describing the archive

getTick

Get a tick value.

public  getTick({Array})

Parameters

Parameter	Type	Description
`$time`	`int`	Defaults to the current time if not specified

create

public  create({Array})

Parameters

Parameter	Type	Description
`$tickSec`	`int`

setValue

public  setValue({Array})

Parameters

Parameter	Type	Description
`$dsname`	`string`
`$value`	`float`

update

The update function stores a consolidated data point in the archive for each data source based on the settings

public  update({Array})

supplied when defining the archive.

A primary data point is a single value stored for each 'tick'.
A consolidated data point is a value calculated based on 1 or more primary data points using the consolidation function specified when defining the archive.

How this works is as follows:

Step 1: Load all the available data points ready to be processed
Step 2: Make sure there are data points for all ticks from lastTick to currentTick
Step 3: Check if there are enough primary data points to create a consolidated data point.
Step 4: If so, apply the consolidation function
Step 5: Update the starting point in the archive definition
Step 6: Store the consolidated data point value in the archive.

hasDataSource

public  hasDataSource({Array})

Parameters

Parameter	Type	Description
`$name`	`string`

getDataSources

public  getDataSources({Array})

getArchives

public  getArchives({Array})

getfile

public  getfile({Array})

graph

public  graph({Array})

Parameters

Parameter	Type	Description
`$dsname`	`string`
`$archiveID`	`string`
`$`	`false`

data

Retrieve the raw primary data points stored in a data source.

public  data({Array})

Parameters

Parameter	Type	Description
`$dsname`	`string`	the name of the data source
`$`	`false`

getCDPLength

Calculate the length of a row within an archive.

private  getCDPLength({Array})

getDataSourceOffset

Calculate the start position in the file of a data source.

private  getDataSourceOffset({Array})

Parameters

Parameter	Type	Description
`$dsname`	`NULL`	The name of the data source. If omitted, returns the position of the byte after all data sources

getArchiveOffset

Calculate the start position in the file of an archive.

private  getArchiveOffset({Array})

Parameters

Parameter	Type	Description
`$archiveID`	`string`	The name of the archive

restoreOptions

Load data sources and archives from an existing RRD database file.

private  restoreOptions({Array})

writeDataSource

private  writeDataSource({Array})

Parameters

Parameter	Type	Description
`$ds`	`array`

writeArchive

private  writeArchive({Array})

Parameters

Parameter	Type	Description
`$archive`	`array`

writeCDP

private  writeCDP({Array})

Parameters

Parameter	Type	Description
`$tick`	`int`
`$values`	`array`
`$doWrite`	`bool`

consolidate

private  consolidate({Array})

Parameters

Parameter	Type	Description
`$cf`	`int`
`$dataPoints`	`array`
`$dsType`	`int`

Generated by Hazaar API Doc Generator