-class Values(PluginData)
- | A Values object used for dispatching values to collectd and receiving
- | values from write callbacks.
- |
- | Method resolution order:
- | Values
- | PluginData
- | object
- |
- | Methods defined here:
- |
- | dispatch(...)
- | dispatch([type][, values][, plugin_instance][, type_instance][, plugin][, host][, time][, interval]) -> None. Dispatch a value list.
- |
- | Dispatch this instance to the collectd process. The object has members
- | for each of the possible arguments for this method. For a detailed
- | explanation of these parameters see the member of the same same.
- |
- | If you do not submit a parameter the value saved in its member will be
- | submitted. If you do provide a parameter it will be used instead,
- | without altering the member.
- |
- | write(...)
- | write([destination][, type][, values][, plugin_instance][, type_instance][, plugin][, host][, time][, interval]) -> None. Dispatch a value list.
- |
- | Write this instance to a single plugin or all plugins if 'destination' is obmitted.
- | This will bypass the main collectd process and all filtering and caching.
- | Other than that it works similar to 'dispatch'. In most cases 'dispatch' should be
- | used instead of 'write'.
- |
- | ----------------------------------------------------------------------
- | Data descriptors defined here:
- |
- | interval
- | The interval is the timespan in seconds between two submits for the
- | same data source. This value has to be a positive integer, so you can't
- | submit more than one value per second. If this member is set to a
- | non-positive value, the default value as specified in the config file
- | will be used (default: 10).
- |
- | If you submit values more often than the specified interval, the average
- | will be used. If you submit less values, your graphs will have gaps.
- |
- | values
- | These are the actual values that get dispatched to collectd.
- | It has to be a sequence (a tuple or list) of numbers.
- | The size of the sequence and the type of its content depend on the type
- | member your types.db file. For more information on this read the
- | types.db man page.
- |
- | If the sequence does not have the correct size upon dispatch a
- | RuntimeError exception will be raised. If the content of the sequence
- | is not a number, a TypeError exception will be raised.