Class RRDUtil

Initializer

The RRD creation command is only used if the RRD file doesn't exist and no rrdCommand was specified with the save() method.

Parameters:

• defaultRrdCreateCommand (string) - RRD creation command
• defaultCycleTime (integer) - expected time to periodically collect data

Overrides: object.__init__

Report on the number of data points collected in a cycle, and reset the counter for a new cycle.

Returns: number

number of data points collected during the cycle

Given a path, return its location from $ZENHOME and the perf/ directories.

Parameters:

• path (string) - name for a datapoint in a path (eg device/component/datasource_datapoint)

Returns: string

absolute path

Return the step value for the provided cycleTime. This is a hook for altering the default step calculation.

Return the heartbeat value for the provided cycleTime. This is a hook for altering the default heartbeat calculation.

Save the value provided in the command to the RRD file specified in path.

If the RRD file does not exist, use the rrdType, rrdCommand, min and max parameters to create the file.

Parameters:

• path (string) - name for a datapoint in a path (eg device/component/datasource_datapoint)
• value (number) - value to store into the RRD file
• rrdType (string) - RRD data type (eg ABSOLUTE, DERIVE, COUNTER)
• rrdCommand (string) - RRD file creation command
• cycleTime (number) - length of a cycle
• min (number) - minimum value acceptable for this metric
• max (number) - maximum value acceptable for this metric
• allowStaleDatapoint (boolean) - attempt to write datapoint even if a newer datapoint has already been written

Returns: number or None

the parameter value converted to a number

Save the value provided in the command to the RRD file specified in path. Afterward, fetch the latest value for this point and return it.

If the RRD file does not exist, use the rrdType, rrdCommand, min and max parameters to create the file.

Parameters:

• path (string) - name for a datapoint in a path (eg device/component/datasource_datapoint)
• value (number) - value to store into the RRD file
• rrdType (string) - RRD data type (eg ABSOLUTE, DERIVE, COUNTER)
• rrdCommand (string) - RRD file creation command
• cycleTime (number) - length of a cycle
• min (number) - minimum value acceptable for this metric
• max (number) - maximum value acceptable for this metric
• allowStaleDatapoint (boolean) - attempt to write datapoint even if a newer datapoint has already been written

Returns: number or None

the parameter value converted to a number