[
 'speed' => [
  'name' => 'speed',
  'desc' => 'Speed Counter',
  'type' => 0x02, // COUNTER
  'ticks' => 600,
  'min' => 0,
  'max' => null,.
  'last' => -1,
 ],
 'temperature' => [
  'name' => 'temperature',
  'desc' => 'Temperature Gauge',
  'type' => 0x01, // GAUGE
  'ticks' => 60,
  'min' => -40,
  'max' => 100,
  'last' => -1,
 ],
]

The 'type' field indicates the data source type (e.g., GAUGE, COUNTER, ABSOLUTE). The 'ticks' field indicates how many ticks are stored for this data source before consolidation. The 'last' field tracks the index of the last tick written for this data source.

Note: The actual structure and fields of the data source may vary based on implementation details and requirements. The 'last' field is initialized to -1 to indicate that no ticks have been written yet. The 'min' and 'max' fields can be used to enforce value limits for the data source, where null indicates no limit.

This array is used internally to manage the data sources and their associated metadata when writing to the metric file.

The data sources are stored in the metric file with a specific format, and this array helps to keep track of their definitions and current state during runtime. The 'ticks' field is crucial for determining when to consolidate data points into the archive based on the defined tick count for each data source. The 'type' field is used to determine how values are updated for the data source (e.g., whether to sum values for a COUNTER or take the maximum for a GAUGE). The 'desc' field provides a human-readable description of the data source, which can be useful for documentation or display purposes when analyzing the metrics. Overall, this array serves as the central structure for managing the data sources within the Metric class and ensuring that they are correctly defined and updated according to the specified configuration.

lastTick

private array $lastTick = array (
  'data' => 
  array (
  ),
  'archive' => 
  array (
  ),
)

dataSourceTypes

private array $dataSourceTypes = array (
  'GAUGE' => 0,
  'COUNTER' => 0,
  'ABSOLUTE' => 0,
  'GAUGEZ' => 0,
)

archiveCFs

private array $archiveCFs = array (
  'AVERAGE' => 0,
  'MIN' => 0,
  'MAX' => 0,
  'LAST' => 0,
  'COUNT' => 0,
)

Methods

__construct

Create a new instance.

public __construct(string $file): void

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

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

Parameter	Type	Description
`$dsname`	`string`	the name of the data source to generate the graph for
`$archiveID`	`string`	the ID of the archive to use (default is 'default')
`$`	`false`

Parameter	Type	Description
`$cf`	`int`	consolidation function identifier
`$dataPoints`	`array`	array of numeric data points to consolidate
`$dsType`	`int`	optional data source type identifier